zacklerner/sanity-gridsome-blog

Blog with Gridsome

My docs

Gridsome Plugins Included

@gridsome/plugin-sitemap

You'll probably need to generate a sitemap for your site, but feel free to remove this if you don't! Make sure to add the appropriate siteUrl to gridsome.config.js. More complete documentation on the plugin can be found here.

@gridsome/plugin-flexsearch

Solid integration of FlexSearch.js with Gridsome. Flexsearch currently has limited support for search within nested data structures. In order to properly search Sanity's implementation of Portable Text blocks will have to be flattened and stored in a custom index for the time being. This is a top priority on the roadmap for this base theme.

More complete documentation on the plugin can be found here

Adding a new type of content

1. Add schema in studio/schemas/documents or studio/schemas/objects: https://www.sanity.io/docs/content-modelling
2. Add your new schema to studio/schemas/schema.js
3. Update studio/deskStructure.js making sure to add the name of your schema to hidden doc types if a document (optional)
4. Add a template component for your new content in web/source/templates with the appropriate GraphQL query
5. Add the template for your collection to gridsome.config.js: https://gridsome.org/docs/templates/
6. Add the collection to flexsearch's configuration in gridsome.config.js: https://gridsome.org/plugins/gridsome-plugin-flexsearch

Menus

Link lists have been added to the starter theme in the form of

Roadmap

1. Flatten portable text blocks for indexing
2. Warn if siteUrl not set or prompt for siteUrl on installation
3. Move this roadmap to a github project a la https://github.com/gridsome/gridsome/projects/2
4. Implement page transitions
5. Add test user access control to Sanity Studio: https://www.sanity.io/docs/access-control

---

Sanity Starter Docs - Blog with Gridsome

Fully customizable blog template with a Vue.js front-end.

Deployed from sanity.io/create.

What you have

• A fast by default blog with Gridsome
• Structured content using Sanity.io
• Global deployment on Netlify

Quick start

1. Clone this repository
2. npm install in the project root folder on local
3. npm run dev to start the studio and frontend locally
   • Your studio should be running on http://localhost:3333
   • Your frontend should be running on http://localhost:8080
4. npm run build to build to production locally

Enable real-time content preview on development

1. Go to your project’s API settings on manage.sanity.io and create a token with read rights.
2. Rename .env.development.tenplate to .env.development and paste in the token: SANITY_READ_TOKEN="yourTokenHere".
3. Restart the development server (ctrl + C and npm run dev).

If you want to turn off preview you can set watchMode: false in gridsome-config.js. If you just want to preview published changes you can set overlayDrafts: false in gridsome-config.js.

Deploy changes

Netlify automatically deploys new changes commited to master on GitHub. If you want to change deployment branch, do so in build & deploy settings on Netlify.

This starter comes with a Netlify-widget that lets you trigger new deploys from Sanity Studio.

Stuck? Get help

Join Sanity’s developer community or ping us on twitter.