Skip to content

The documentation starter you were looking for ⚑️

License

Notifications You must be signed in to change notification settings

jpedroschmitz/gatsby-starter-rocketdocs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A illustration of file that is the @rocketseat/gatsby-theme-docs logo

Gatsby Starter: Rocket Docs

Out of the box Gatsby Starter for creating documentation websites easily and quickly. With support for MDX, code highlight, Analytics, SEO and more πŸ”₯ Using the theme: @rocketseat/gatsby-theme-docs

PRs welcome! License Follow @jpedroschmitz

πŸš€ Features

  • πŸ“ MDX for docs;
  • πŸ›£ Yaml-based sidebar navigation;
  • πŸ“± Responsive and mobile friendly;
  • πŸ–₯ Code highlighting with prism-react-renderer and react-live support;
  • πŸ₯‡ SEO (Sitemap, schema.org data, Open Graph and Twitter tags).
  • πŸ“ˆ Google Analytics support;
  • πŸ“„ Custom docs schema;
  • πŸ–± Table of Contents;
  • ⚑️ Offline Support & WebApp Manifest;
  • and much more πŸ”₯

⚑️ Getting started

  1. Create the website.

    npx gatsby new rocketdocs https://github.com/jpedroschmitz/gatsby-starter-rocketdocs
  2. Start developing.

    cd rocketdocs
    gatsby develop
  3. Are you ready for launch?

    Your site is now running at http://localhost:8000

πŸ“„ Docs

Looking for docs? Check our live demo and documentation website.


Made with πŸ’œ by JoΓ£o Pedro