Giter Club home page Giter Club logo

gatsby-starter-rocket-docs's Introduction

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!

gatsby-starter-rocket-docs's People

Contributors

jpedroschmitz avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.