mirror of
https://github.com/testthedocs/awesome-docs.git
synced 2026-07-16 14:31:25 -05:00
edbcb85587
- Restructured homepage with clear category overview - Created comprehensive Site Generators page with detailed tool descriptions - Built API Documentation page covering tools, testing, and best practices - Added Quality Assurance page with linting, testing, and accessibility tools - Updated navigation with organized tool categories and resources - Enhanced sidebar with logical content grouping - Transformed flat README list into searchable, navigable documentation New structure: - Core Tools: Site Generators, API Documentation - Content & Quality: Writing Tools, Quality Assurance - Resources: Style Guides, Reading List, GitHub Actions - Getting Started: Introduction, Installation All content now properly categorized and easily discoverable through navigation and search.
4.7 KiB
4.7 KiB
Site Generators
Static site generators specifically designed for documentation, offering features like themes, plugins, and optimized workflows for technical content.
Popular Documentation Generators
VitePress
- Website: vitepress.dev
- Description: Vue-powered static site generator, fast and modern
- Best for: Vue.js projects, modern documentation sites
Docusaurus
- Website: docusaurus.io
- Description: React-based documentation platform by Meta
- Best for: React projects, large documentation sites
MkDocs
- Website: mkdocs.org
- Description: Python-based static site generator
- Best for: Python projects, simple setup
GitBook
- Website: gitbook.com
- Description: Modern documentation platform with collaborative features
- Best for: Team collaboration, internal documentation
Framework-Specific Generators
Astro
- Website: astro.build
- Extensions: Starlight - Documentation theme
- Best for: Performance-focused sites, multi-framework support
Next.js
- Website: nextra.site
- Description: Simple, powerful and flexible site generation framework
- Best for: React/Next.js projects
Nuxt.js
- Website: docus.dev
- Description: Write docs with MDX and deploy with Nuxt
- Best for: Vue/Nuxt projects
Language-Specific Generators
Rust
- Tool: mdBook
- Description: Command line tool to create books with Markdown files
- Best for: Rust projects, book-style documentation
.NET
- Tool: DocFX
- Description: Static documentation generator for .NET
- Best for: .NET projects, API documentation
Python
- Tool: Sphinx
- Description: Documentation generator with powerful extensions
- Best for: Python projects, complex documentation
Lightweight & Simple
Docsify
- Website: docsify.js.org
- Description: Magical documentation site generator without build process
- Best for: Simple sites, no build step required
11ty
- Website: 11ty.dev
- Description: Simple static site generator with multiple template languages
- Best for: Flexibility, custom designs
Zola
- Website: getzola.org
- Description: Fast static site generator written in Rust
- Best for: Performance, simplicity
Specialized Solutions
Antora
- Website: antora.org
- Description: Multi-repository documentation site generator
- Best for: Large organizations, multiple repositories
Quartz
- Website: quartz.jzhao.xyz
- Description: Transform your Obsidian vault into a website
- Best for: Knowledge management, Obsidian users
Log4brains
- Website: log4brains.org
- Description: Documentation of architecture decision records (ADRs)
- Best for: Architecture decisions, ADR documentation
Extensions & Themes
Docsify Extensions
- docsify-themeable - Themeable extension
MkDocs Extensions
- Material for MkDocs - Material Design theme
- Tooltipster Links Plugin - Enhanced tooltips
Sphinx Extensions
- MyST - Markdown parser
- sphinx-design - UI components
- Furo - Clean theme
Search Solutions
- Meilisearch - Fast, typo-tolerant search
- pagefind - Static search for static sites
- Typesense - Open source search engine
Choosing the Right Generator
Consider These Factors:
- Team Skills - What languages/frameworks does your team know?
- Project Size - Single repo vs. multi-repo documentation?
- Customization - How much design flexibility do you need?
- Performance - How fast does the site need to be?
- Maintenance - How much ongoing maintenance can you handle?
Quick Recommendations:
- New to docs: Start with Docusaurus or VitePress
- Python team: Use MkDocs or Sphinx
- Performance focus: Try Astro or Zola
- Simple needs: Consider Docsify or 11ty
- Large organization: Look at Antora or GitBook