Documentation generators
Table of Contents
There are several types of static site generators (SSG).
- General purpose. For example:
- Next.js
- Gatsby
- Nuxt
- Astro
- Blogs - they rather started as blogs, but slowly evolve into more general purpose. For example:
- Hugo
- Jekyll
- Second brain, digital garden. For example:
- Quartz
- And documentation generators. This is the post about the last category
Generators #
This is not an exhaustive list
Generator | Technology | Notes |
---|---|---|
MkDocs + mkdocs-material | Python | Awesome list |
Starlight | JS, Astro | Starlight plugins, Astro plugins |
nextra | JS, React, Next.js | |
vitepress | JS, Vue | Awesome list |
Docusaurus | Js, React | Awesome list |
mdBook | Rust | mdbook-plugins |
Docz | JS, React, Gatsby | |
Docsify.js | JS | |
docpress | JS | |
Sphinx | Python |
Themes #
Plus there are themes for other (general purpose) SSGs:
Theme | Technology |
---|---|
just-the-docs | Ruby, Jekyll |
documentation-theme-jekyll | Ruby, Jekyll |
hextra | Go, Hugo |
doks | Go, Hugo, JS, Hyas |
docsy | Go, Hugo |
hugo-book | Go, Hugo |
theme-documentation | Go, Hugo |
11ty-docs-template | JS, 11ty |
More themes:
- https://cloudcannon.com/blog/twelve-amazing-free-hugo-documentation-themes/
- https://jamstackthemes.dev/archetype/documentation/
Read more: Markdown parsers, Components for Web