https://github.com/jpedroschmitz/gatsby-starter-rocketdocs

The documentation starter you were looking for ⚡️
https://github.com/jpedroschmitz/gatsby-starter-rocketdocs

documentation gatsby gatsby-starter gatsby-theme rocketseat

Last synced: 7 days ago
JSON representation

The documentation starter you were looking for ⚡️

• Host: GitHub
• URL: https://github.com/jpedroschmitz/gatsby-starter-rocketdocs
• Owner: jpedroschmitz
• License: mit
• Created: 2020-01-28T17:41:26.000Z (about 5 years ago)
• Default Branch: main
• Last Pushed: 2023-05-15T17:20:06.000Z (over 1 year ago)
• Last Synced: 2025-01-16T10:24:11.682Z (14 days ago)
• Topics: documentation, gatsby, gatsby-starter, gatsby-theme, rocketseat
• Language: JavaScript
• Homepage: https://rocketdocs-gatsby.vercel.app/
• Size: 1.35 MB
• Stars: 218
• Watchers: 9
• Forks: 32
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  





  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





  

  

  

    

  



## 🚀 Features

- 📝 MDX for docs;

- 🛣 Yaml-based sidebar navigation;

- 📱 Responsive and mobile friendly;

- 🖥 Code highlighting with [prism-react-renderer](https://github.com/FormidableLabs/prism-react-renderer) and [react-live](https://github.com/FormidableLabs/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.

   ```sh

   npx gatsby new rocketdocs https://github.com/jpedroschmitz/gatsby-starter-rocketdocs

   ```

2. Start developing.

   ```sh

   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](https://rocketdocs.netlify.app).

---

Made with 💜 by João Pedro