Skip to content

Latest commit

 

History

History
 
 

gatsby-theme-docs

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

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;
  • ⚡️ 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. 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 project roadmap.

📝 License

Licensed under the MIT License.


Made with 💜 by Rocketseat 👋 check our community!