/Slatedocumentation

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

🚀 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.


Made with 💜 by João Pedro