gitdocs

GitDocs

Easy to use, SEO-friendly, beautiful documentation that lives in your git repo.

How does it work

gitdocs is distributed as a cli package on npm. You can simply install it with npm install gitdocs -g and run gitdocs serve to preview your docs or gitdocs build to generate a static site wherever you like.

Installation

Using npm:

npm i -g gitdocs

Using Yarn:

yarn global add gitdocs

Quick Start

Assuming you have a folder with markdown files at /docs, you can automatically preview your docs site by running.

gitdocs serve

or you can check out more here quickstart.

• The readme.md in your repo will be used as the default homepage for your docs
• docs.json allows you to specify your project settings like the version, name and much more
• The navigation will automatically be built using your docs folder structure, but you can add an optional contents.md file to generate your own navigation. See configuration/sidebar or more info.