Skip to main content
Community Plugin
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;
  • 🖱 Table of Contents;
  • ⚡️ 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
  2. Start developing.

    cd rocket-docs
    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 website, click here to access.

📝 License

Licensed under the MIT License.


Made with 💜 by Rocketseat :wave: check our community!