Skip to main content
View plugin on GitHub
See starters using this

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

@rocketseat/gatsby-theme-docs

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

PRs welcome!

License Follow @rocketseat

Features β€’ Getting started β€’ Docs β€’ Contributing β€’ License

πŸš€ 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;
  • ⚑️ Offline Support & WebApp Manifest;
  • and much more πŸ”₯

⚑️ Getting started

  1. Create the website.
gatsby new rocket-docs https://github.com/rocketseat/gatsby-starter-rocket-docs
  1. Start developing.
cd rocket-docs
gatsby develop
  1. 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. Also, don’t forget to check the roadmap.

πŸ—Ί Roadmap

If you’d like to see our next steps or in which feature our bug fix we are working on, please check our roadmap project.

πŸ“ License

Licensed under the MIT License.


Made with πŸ’œ by Rocketseat :wave: check our community!


Docs
Tutorials
Plugins
Blog
Showcase