/gatsby-starter-rocket-docs

The documentation starter you were looking for 🚀🔥

Primary LanguageJavaScriptMIT LicenseMIT

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 @rocketseat

🚀 Features

  • MDX for docs;
  • Fully customizable through the usage of Gatsby Themes (and Theme UI)
  • Sidebar customization with Yaml;
  • Code highlighting with prism-react-renderer and react-live support. Copy code button and option to show line numbers.
  • SEO (Sitemap, schema.org data, Open Graph and Twitter tags).
  • Google Analytics support;
  • Offline Support & WebApp Manifest

⚡️ 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.


Made with 💜 by Rocketseat 👋 check our community!