gitdocs

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

Usage no npm install needed!

<script type="module">
  import gitdocs from 'https://cdn.skypack.dev/gitdocs';
</script>

README

GitDocs Logo

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




GitDocs Example