Skip to content

Latest commit

 

History

History
 
 

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
images
images
 
 
README.md
README.md
 
 
assets-css.md
assets-css.md
 
 
assets-fonts.md
assets-fonts.md
 
 
assets-scripts.md
assets-scripts.md
 
 
assets-svg.md
assets-svg.md
 
 
basic-config.md
basic-config.md
 
 
body-html-attributes.md
body-html-attributes.md
 
 
client-api.md
client-api.md
 
 
code-of-conduct.md
code-of-conduct.md
 
 
code-splitting.md
code-splitting.md
 
 
components.md
components.md
 
 
config.md
config.md
 
 
custom-css.md
custom-css.md
 
 
custom-fonts.md
custom-fonts.md
 
 
data-dynamic.md
data-dynamic.md
 
 
data-store-api.md
data-store-api.md
 
 
deploy-to-amazon-s3.md
deploy-to-amazon-s3.md
 
 
deploy-to-amplify.md
deploy-to-amplify.md
 
 
deploy-to-gitlab.md
deploy-to-gitlab.md
 
 
deploy-to-netlify.md
deploy-to-netlify.md
 
 
deploy-to-zeit-now.md
deploy-to-zeit-now.md
 
 
deployment.md
deployment.md
 
 
dev-tools.md
dev-tools.md
 
 
directory-structure.md
directory-structure.md
 
 
environment-variables.md
environment-variables.md
 
 
faq.md
faq.md
 
 
fetching-data.md
fetching-data.md
 
 
filtering-data.md
filtering-data.md
 
 
gridsome-cli.md
gridsome-cli.md
 
 
guide-comments.md
guide-comments.md
 
 
guide-forms.md
guide-forms.md
 
 
guide-search.md
guide-search.md
 
 
head.md
head.md
 
 
how-it-works.md
how-it-works.md
 
 
how-to-contribute.md
how-to-contribute.md
 
 
how-to-create-a-plugin.md
how-to-create-a-plugin.md
 
 
how-to-upgrade.md
how-to-upgrade.md
 
 
images.md
images.md
 
 
install-plugins.md
install-plugins.md
 
 
layouts.md
layouts.md
 
 
linking.md
linking.md
 
 
overriding-index.md
overriding-index.md
 
 
page-transitions.md
page-transitions.md
 
 
pages.md
pages.md
 
 
pagination.md
pagination.md
 
 
plugins.md
plugins.md
 
 
prerendering.md
prerendering.md
 
 
prerequisites.md
prerequisites.md
 
 
querying-data.md
querying-data.md
 
 
routing.md
routing.md
 
 
rplp-pattern.md
rplp-pattern.md
 
 
server-api.md
server-api.md
 
 
site-meta-data.md
site-meta-data.md
 
 
starters.md
starters.md
 
 
taxonomies.md
taxonomies.md
 
 
templates.md
templates.md
 
 
transformer-api.md
transformer-api.md
 
 
troubleshooting.md
troubleshooting.md
 
 
use-cases.md
use-cases.md
 
 

README.md

Getting started

Gridsome is a Vue.js-powered, modern site generator for building the fastest possible websites for any Headless CMS, APIs or Markdown-files. Gridsome makes it easy and fun for developers to create fast, beautiful websites without needing to become a performance expert.

Why Gridsome?

  • Local development with hot-reloading - See code changes in real-time.
  • Data source plugins - Use it for any popular Headless CMSs, APIs or Markdown-files.
  • File-based page routing - Quickly create and manage routes with files.
  • Centralized data managment - Pull data into a local, unified GraphQL data layer.
  • Vue.js for frontend - A lightweight and approachable front-end framework.
  • Auto-optimized code - Get code-splitting and asset optimization out-of-the-box.
  • Static files generation - Deploy securely to any CDN or static web host.

Learn more about how Gridsome works

Prerequisites

You should have basic knowledge about HTML, CSS, Vue.js and how to use the Terminal. Knowing how Vue Single File components & GraphQL works is a plus, but not required. Gridsome is a great way to learn both.

Gridsome requires Node.js and recommends Yarn. How to setup

1. Install Gridsome CLI tool

Using yarn:
yarn global add @gridsome/cli

Using npm:
npm install --global @gridsome/cli

2. Create a Gridsome project

  1. gridsome create my-gridsome-site to create a new project
  2. cd my-gridsome-site to open folder
  3. gridsome develop to start local dev server at http://localhost:8080
  4. Happy coding 🎉🙌

3. Next steps

  1. Create .vue components in the /pages directory to create page routes.
  2. Use gridsome build to generate static files in a /dist folder