awesome-docs

A curated list of awesome documentation tools
https://github.com/testthedocs/awesome-docs

Last synced: 16 days ago
JSON representation

Accessibility
API
- Swagger
- Spectral
- RapiDoc
- Zalando RESTful API and Event Guidelines
- Bump.sh
- Optic
- What we can learn from UX professionals when designing APIs
- Tips for better documentation with OpenAPI
- Restish
- API Guidelines
- Hoppscotch
- json-schema-sensitivity-checker
- Redoc-Editor
- ReDoc
- Speccy
- swaggerui
- widdershins
- Document360 API Documentation
- OpenAPI 3 CLI
- Bruno
- DevDocsAI - AI-powered API documentation generator. Paste code, get docs in 30 seconds.
- Sourcey - Static documentation generator that combines OpenAPI references with markdown guides into a single site.
AsciiDoc
Browser Extensions
Browser Testing
Editor
- HackMD
- Visual Studio Code
- Zettlr
- Zed
- Mark Text
- Lapce
- DraftView Edit - Paste a GitHub or GitLab file URL to edit it in DraftView and submit it back as a pull request or merge request.
- Notula - Desktop WYSIWYG editor for the Markdown in a git repository, with comment threads committed beside the documents.
Feedback
- Papercups
- notabene - Renders a repo's Markdown/MDX as a navigable site with anchored, Google-Docs-style comments; an agent applies them as source edits and journals the changes.
GitHub Actions
- Spellcheck Action
- DOCtor-RST
- Run misspell with reviewdog
- Alex Action
- Lighthouse CI Action
- TOC Generator
- TODO to Issue Action
- Vale
- EkLine
- DocPulse
- constitution-lint-action - style AI agent constitution file for structural completeness (mission statement, hard rules, escalation procedures, spending limits).
- DocFlow
- readme-ci
- Pushpen - Generates and updates README, changelog, API docs, and onboarding guides from a repository's actual code and commit history on every push, opened as a pull request.
- docproof - Fails a build when documentation contradicts the repository, and reports what share of the documentation it read.
- DocuPilot - GitHub App that auto-generates README, CHANGELOG, and API docs on every push via AI-powered PRs. Free for 1 repo.
- DocFlow
Hosting
- GitBook
- Netlify
- Doctave
- Mintlify
- Read The Docs
- Ferndesk
- Jamdesk
- Papervine
Knowledge Base
- Logseq
- Document360
- Specsight
- Falconer
- wiki - Indexed Markdown knowledge bases for agents, with deterministic indexes, scoped retrieval, linting, and merge handling for parallel edits.
- reqlan - Semantic requirements as code: a graph of named ideas your agents can search, link, reuse, test and maintain.
- Specsight
Mockup
Quality Assurance
- Swimm
- Readable
- Capitalize My Title
- Woke
- Your automated tester
- Rules example
- Alex
- brok
- case-police
- Doc Detective
- HtmlTest
- InnovationEngine
- Linkspector
- lychee
- Harper
- Vale
- Your automated tester
- Your automated tester
- docproof - Checks whether what documentation claims is still true of the repository: file paths, CLI flags, versions, and documented imports, each resolved against the code and its git history.
Reading
- Search
Screencast
- Asciinema
- Codio
- Editly
- Kap
- Peek
- Screenity
- Terminalizer
Screenshot
- Shottr
- shot-scraper
- Flameshot
- Heroshot
- ItsPaint
Site Generators
- Docsify Extensions
  - docsify-themeable
- Hugo Extensions
  - Hugo modules
- MkDocs Extensions
  - Material for MkDocs
  - Tooltipster Links Plugin
- Search
- Sphinx Extensions
- Sphinx Themes
- - Antora
  - Docusaurus
  - Docsify
  - MkDocs
  - Sphinx
  - VuePress
  - Zola
  - Document Node
  - 11ty
  - Dokz
  - Astro
  - Starlight
  - Docus
  - DocFX
  - Docsite
  - Gatsby Docs Kit
  - Log4brains
  - mdBook
  - MDX-GO
  - Nextra
  - Portray
  - Quartz
  - RcPress
  - Fumadocs
  - Vocs
  - xyd
  - VitePress
  - xyd
  - Bengal
  - Quarto

Programming Languages

TypeScript 21 JavaScript 18 Python 12 Rust 4 HTML 4 Go 4 Swift 1 SCSS 1 C# 1 Haskell 1

Categories

Style Guides 52 Site Generators 50 Tool Collection 43 Reading 39 API 22 Quality Assurance 19 GitHub Actions 17 Hosting 8 Editor 8 Knowledge Base 7 Screencast 7 Accessibility 5 Screenshot 5 AsciiDoc 5 Browser Extensions 3 Mockup 3 Viewer 3 Writing 3 Browser Testing 3 Feedback 2 Watching 1 User Behavior Analytics 1 Spelling 1

Sub Categories

Sphinx Themes 66 Search 41 Sphinx Extensions 6 MkDocs Extensions 2 Docsify Extensions 1 Hugo Extensions 1

Keywords

documentation 20 markdown 12 developer-tools 7 testing 6 docs 6 javascript 6 static-site-generator 6 react 6 github-actions 5 design 4 theme 4 editor 4 documentation-tool 4 command-line 4 open-source 4 python 4 automation 4 docs-as-code 4 cli 4 mkdocs 3 productivity 3 link-checker 3 electron 3 playwright 3 api 3 typescript 3 openapi 3 openapi3 3 mdx 3 macos 3 linux 2 testing-tools 2 vue 2 web 2 tools 2 documentation-generator 2 technical-writing 2 gatsby 2 mac 2 docker 2 awesome-list 2 design-systems 2 design-tools 2 api-documentation 2 http 2 static-analysis 2 swagger 2 redoc 2 record 2 bash 2