This repository has been archived on 2024-04-08. You can view files and clone it, but cannot push or open issues or pull requests.
dagger/tools/gendocs/README.md
Andrea Luzzardi 6ddb973f03 docs: move gendocs tool to dagger/dagger
Signed-off-by: Andrea Luzzardi <aluzzardi@gmail.com>
2021-05-21 11:11:21 -07:00

2.0 KiB
Raw Blame History

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;
  • 🛣 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 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!