{"repo":"hasura/gatsby-gitbook-starter","free":true,"listed":false,"github":"https://github.com/hasura/gatsby-gitbook-starter","clone":"git clone https://github.com/hasura/gatsby-gitbook-starter.git","description":"Generate GitBook style modern docs/tutorial websites using Gatsby + MDX","language":"JavaScript","stars":991,"topics":["gatsby","gitbook","docs-generator","documentation-generator","markdown","mdx","gatsby-mdx","gatsby-starter","algolia","syntax-highlighting"],"license":"MIT","category":"saas-starters-boilerplates","readme_excerpt":"gatsby-gitbook-starter Kick off your project with this starter to create a powerful/flexible docs/tutorial web apps. Motivation We wanted to create a GraphQL tutorial series. The content would be written by developers for various languages/frameworks and what better than writing it in Markdown! And since this is a tutorial series we also needed rich embeds, syntax highlighting and more customisations. We also wanted to serve these tutorials in sub paths of learn.hasura.io. To serve all these requirements, we decided to use Gatsby + MDX (Markdown + JSX) to extend markdown and used a neat consistent theme like the one at GitBook and deployed as docker containers. 🔥 Features - Write using Markdown / MDX - GitBook style theme - Syntax Highlighting using Prism [ Bonus : Code diff highlighting] - Search Integration with Algolia - Progressive Web App, Works Offline - Google Analytics Integration - Automatically generated sidebar navigation, table of contents, previous/next - Dark Mode toggle - Edit on Github - Fully customisable - Rich embeds and live code editor using MDX - Easy deployment: Deploy on Netlify / Now.sh / Docker 🔗 Live Demo Here's a live demo 🚀 Quickstart Get started by running the following commands: Visit http://localhost:8000/ to view the app. 🔧 Configure Write markdown files in content folder. Open config.js for templating variables. Broadly configuration is available for gatsby , header , sidebar and siteMetadata . - gatsby config for global configuration lik","default_branch":null,"files":null,"tree":[],"storefront":"/r/hasura","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/hasura/gatsby-gitbook-starter/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}