/gatsby-gitbook-starter

Generate GitBook style modern docs/tutorial websites using Gatsby

Primary LanguageJavaScriptMIT LicenseMIT

IMPORTANT

This repo is archived. Use BooGi instead, where all development will happen.

Gatsby-Gitbook-Starter

Netlify Status GitHub release (latest SemVer)

Kick off your project with this template to create a powerful/flexible docs/tutorial web apps.

🔥 Features

  • Write using Markdown / MDX
  • GitBook style theme, based on https://docs.gitbook.com/
  • Syntax Highlighting using Prism [Bonus: Code diff highlighting]
  • Search Integration with Algolia (local search capabilities are planned)
  • Progressive Web App, Works Offline
  • Google Analytics Integration
  • Automatically generated sidebar navigation, table of contents, previous/next
  • Additional components to make documentation beautiful and user friendly, e.g. emojis, badges, icons, column layout, highlights, jargon/abbreviations and more!
  • Edit on Gitlab, Github or Bitbucket
  • Fully customisable
  • Rich embeds and live code editor using MDX
  • Easy deployment: Deploy on Netlify / Now.sh / Docker
  • Easily reusable in multiple projects

🔗 Live Demo

Here's a live demo.

☁️ Deploy

Deploy to Netlify