https://github.com/insuusvenerati/frog-docs

https://github.com/insuusvenerati/frog-docs

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/insuusvenerati/frog-docs
• Owner: insuusvenerati
• License: mit
• Created: 2021-09-07T19:59:13.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-06-26T08:21:40.000Z (over 2 years ago)
• Last Synced: 2023-03-02T00:06:37.426Z (almost 2 years ago)
• Language: JavaScript
• Size: 310 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• 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 rocket-docs https://github.com/rocketseat/gatsby-starter-rocket-docs

   ```

2. Start developing.

   ```sh

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

---

Made with 💜 by Rocketseat :wave: [check our community!](https://discordapp.com/invite/gCRAFhc)