Migrate to Netlify Today

Netlify announces the next evolution of Gatsby Cloud. Learn more

ContactSign Up
Community Plugin
View plugin on GitHub

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


Out of the box Gatsby Theme for creating documentation websites easily and quickly.

PRs welcome!

License Follow @jpedroschmitz

FeaturesGetting startedDocsContributingLicense

πŸš€ 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.

✨ Contributing

Thanks for being interested in contributing! We’re so glad you want to help! Please take a little bit of your time and look at our contributing guidelines and our code of conduct! All type of contributions are welcome, such as bug fixes, issues or feature requests.

πŸ—Ί Changelog

All notable changes to this project will be documented on the CHANGELOG file.

πŸ“ License

Licensed under the MIT License.

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

Β© 2023 Gatsby, Inc.