gitdocs/readme.md

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

![GitDocs Logo](docs/.static/logo-markdown.png)

GitDocs helps you create beautiful, SEO-friendly documentation sites from markdown files that live alongside your source code. Cross-compile from multiple git repos and run locally for a great publishing experience.

## Features

- Syntax highlighting out of the box.
- Fast static searching of all your docs.
- Cross-compile from multiple git repos.
- Static JSON data for every page.
- Automatically generated table of contents.
- SEO-friendly--everything is static!

## Example Sites

- https://gitdocs.netlify.com
- https://docs.timber.io

<br/>
<br/>
<br/>

![GitDocs Example](https://cl.ly/010X2F1Q413e/Screen%20Recording%202018-07-09%20at%2004.59%20PM.gif)

<div align="center">
  <br /> <br /> <br />
  <a href="https://travis-ci.org/timberio/gitdocs"><img src="https://img.shields.io/travis/timberio/gitdocs/master.svg?style=flat-square" alt="Build Status" /></a>
  <a href="https://coveralls.io/github/timberio/gitdocs"><img src="https://img.shields.io/coveralls/github/timberio/gitdocs/master.svg?style=flat-square" alt="Code Coverage" /></a>
  <a href="https://github.com/timberio/gitdocs/releases"><img src="https://img.shields.io/github/release/timberio/gitdocs.svg?style=flat-square" alt="Gitdocs Version" /></a>
  <br /> <br />
  <a href="https://timber.io">MIT © Timber</a>
</div>