Gridsome
Last updated Apr 21, 2026
is a Vue.js powered Jamstack framework for building static generated websites and applications that are fast by default. In this guide, you will create a new Gridsome project and deploy it using Cloudflare Pages. You will use the @gridsome/cli ↗︎, a command line tool for creating new Gridsome projects.
Install Gridsome
Install the @gridsome/cli by running the following command in your terminal:
npm install --global @gridsome/cli
Set up a new project
With Gridsome installed, set up a new project by running gridsome create. The create command accepts a name that defines the directory of the project created and an optional starter kit name. You can review more starters in the Gridsome starters section ↗︎.
npx gridsome create my-gridsome-website
Before you continue
All of the framework guides assume you already have a fundamental understanding of Git ↗︎. If you are new to Git, refer to this summarized Git handbook ↗︎ on how to set up Git on your local machine.
If you clone with SSH, you must generate SSH keys ↗︎ on each computer you use to push or pull from GitHub.
Refer to the GitHub documentation ↗︎ and Git documentation ↗︎ for more information.
Create a GitHub repository
Create a new GitHub repository by visiting repo.new ↗︎. After creating a new repository, go to your newly created project directory to prepare and push your local application to GitHub by running the following commands in your terminal:
git init
git remote add origin https://github.com/<your-gh-username>/<repository-name>
git add .
git commit -m "Initial commit"
git branch -M main
git push -u origin main
Deploy with Cloudflare Pages
To deploy your site to Pages:
To deploy your site to Pages:
- In the Cloudflare dashboard, go to the Workers & Pages page. Go to Workers & Pages ↗
- Select Create application.
- Select the Pages tab.
- Select Import an existing Git repository.
- Select the new GitHub repository that you created and then select Begin setup.
- In the Build settings section, select Gridsome as your Framework preset. Your selection will provide the following information:
Configuration option | Value
| Production branch | main |
| --- | --- |
| Build command | npx gridsome build |
| Build directory | dist |
After configuring your site, you can begin your first deploy. You should see Cloudflare Pages installing vuepress, your project dependencies, and building your site, before deploying it.
Note
For the complete guide to deploying your first site to Cloudflare Pages, refer to the Get started guide.
After deploying your site, you will receive a unique subdomain for your project on *.pages.dev. Every time you commit new code to your Gridsome project, Cloudflare Pages will automatically rebuild your project and deploy it. You will also get access to preview deployments on new pull requests, so you can preview how changes to your site look before deploying them to production.
Learn more
By completing this guide, you have successfully deployed your Gridsome site to Cloudflare Pages. To get started with other frameworks, refer to the list of Framework guides.
Was this helpful?
YesNo
On this page
{"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/pages/framework-guides/deploy-a-gridsome-site/#page","headline":"Gridsome","description":"Deploy a Gridsome site to Cloudflare Pages.","url":"https://developers.cloudflare.com/pages/framework-guides/deploy-a-gridsome-site/","inLanguage":"en","image":"https://developers.cloudflare.com/pages/framework-guides/deploy-a-gridsome-site/og.png?v=e8f10b91181aecc1","dateModified":"2026-04-21","publisher":{"@type":"Organization","name":"Cloudflare","description":"One platform for your apps, agents, and workforce. Build, secure, and scale without managing infrastructure","url":"https://www.cloudflare.com/","sameAs":["https://github.com/cloudflare","https://www.linkedin.com/company/cloudflare","https://x.com/cloudflare"],"logo":{"@type":"ImageObject","url":"https://developers.cloudflare.com/logo.svg"},"address":{"@type":"PostalAddress","streetAddress":"101 Townsend St","addressLocality":"San Francisco","addressRegion":"CA","postalCode":"94107","addressCountry":"US"},"contactPoint":[{"@type":"ContactPoint","contactType":"Customer Support","url":"https://support.cloudflare.com/","availableLanguage":["English"]},{"@type":"ContactPoint","contactType":"Sales","url":"https://www.cloudflare.com/contact/","availableLanguage":["English"]}]},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}}
description: Deploy a Hexo static site to Cloudflare Pages. title: Hexo image: https://developers.cloudflare.com/pages/framework-guides/deploy-a-hexo-site/og.png?v=5f56880071157e81
Documentation Index
Fetch the complete documentation index at: https://developers.cloudflare.com/pages/llms.txt
Use this file to discover all available pages before exploring further.
Docs