awesome-docs
Awesome Docs 
A curated list of awesome documentation tools, guides and good practice.
If you see a package or project here that is no longer maintained or is not a good fit, please submit a pull request to improve this file. Thank you!
Contributing
Please take a quick gander at the contribution guidelines first.
Thanks to all contributors; you rock!
Contents
- Accessibility
- AsciiDoc
- API
- Browser Extensions
- Browser Testing
- Editor
- Feedback
- GitHub Actions
- Hosting
- Knowledge Base
- Mockup
- Quality Assurance
- Reading
- Screencast
- Screenshot
- Site Generators
- Spelling
- Style Guides
- Tool Collection
- User Behavior Analytics
- Viewer
- Watching
- Writing
Accessibility
AsciiDoc
- adoc Studio
- AdocEditor
- Asciidoctor
- AsciiDoc Alive
- AsciiDoc Pro - Paid AsciiDoc plugin for IntelliJ-based IDEs with live preview, inspections and export.
- IntelliJ AsciiDoc Plugin
- Asciidoc FX
API
- API Guidelines
- Bruno
- Bump.sh
- Cortex - Generates interactive or static API documentation, typed SDKs, and MCP servers from several API specification formats.
- Document360 API Documentation
- Hoppscotch
- json-schema-sensitivity-checker
- oas
- OpenAPI 3 CLI
- Postman
- RapiDoc
- Redoc-Editor
- ReDoc
- Restish
- Sourced - Generates hosted API docs, TypeScript and Python SDKs, llms.txt, and MCP servers from an OpenAPI spec.
- Sourcey - Static documentation generator that combines OpenAPI references with markdown guides into a single site.
- Speccy
- Spectral
- Stoplight Studio
- Swagger
- swaggerui
- Tips for better documentation with OpenAPI
- What we can learn from UX professionals when designing APIs
- widdershins
- Zalando RESTful API and Event Guidelines
- DevDocsAI - AI-powered API documentation generator. Paste code, get docs in 30 seconds.
- Dev Launch Pack - Free browser-based API documentation generator. Parses endpoint definitions and outputs Markdown reference, OpenAPI 3.0 YAML, or a standalone HTML docs page. No signup.
Browser Extensions
Browser Testing
- Agent QA - Source-available natural-language browser testing with reusable execution memory, UI recovery, and run artifacts.
- Nightwatch.js
- Playwright
- Puppeteer
- Selenium
Editor
- 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.
- HackMD
- Lapce
- Mark Text
- Markdown Pro - Paid plugin for JetBrains IDEs that extends the bundled Markdown editor with MDX previews, table editing and documentation checks.
- Notula - Desktop WYSIWYG editor for the Markdown in a git repository, with comment threads committed beside the documents.
- Swimm
- Text to Confluence - Browser-based editor for preparing Markdown and plain text for Confluence.
- TypeFire Markdown Editor - Browser-based Markdown editor and viewer that formats as you type and exports to Markdown, HTML and PDF.
- Visual Studio Code
- Zed
- Zettlr
Feedback
- 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.
- Papercups
GitHub Actions
- Alex Action
- constitution-lint-action Lints a CLAUDE.md-style AI agent constitution file for structural completeness (mission statement, hard rules, escalation procedures, spending limits).
- docproof - Fails a build when documentation contradicts the repository, and reports what share of the documentation it read.
- DocPulse
- DOCtor-RST
- DocuPilot - GitHub App that auto-generates README, CHANGELOG, and API docs on every push via AI-powered PRs. Free for 1 repo.
- DocFlow
- EkLine
- Lighthouse CI Action
- readme-ci
- relnote - Generate GitHub-flavored release notes from a git range (stdlib Python CLI + Action; conventional-commit grouping).
- 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.
- Run misspell with reviewdog
- Spellcheck Action
- TOC Generator
- TODO to Issue Action
- Vale
Hosting
- deed.page - Static hosting that publishes a built docs folder or HTML page to an HTTPS URL with one HTTP PUT or a remote MCP server, with a free plan.
- Doctave
- Ferndesk
- GitBook
- Jamdesk
- Mintlify
- Netlify
- Papervine
- Read The Docs
Knowledge Base
- Carbon Forge - Hosted record where pages, files and code live together and land in one changeset, so a code change and the page that documents it are written together or not at all; people and agents edit it through the same tools, including over MCP.
- Document360
- Falconer
- Folio Wiki - Open-source, self-hosted team wiki that stores every page as a Markdown file in a Git repository, with a built-in MCP server.
- Logseq
- Obsidian
- Oxynote - Self-hosted team wiki with live Prometheus and SQL charts inside pages and pull-request-style reviews.
- reqlan - Semantic requirements as code: a graph of named ideas your agents can search, link, reuse, test and maintain.
- Specsight
- wiki - Indexed Markdown knowledge bases for agents, with deterministic indexes, scoped retrieval, linting, and merge handling for parallel edits.
Mockup
- Animockup
- Drawbly - Browser canvas for rough technical diagrams with editable text and credited PNG export.
- Excalidraw
- Markmap
Quality Assurance
- ai-slop-linter - Flags AI-sounding phrases and em dashes in Markdown docs, commit messages and pull request descriptions, with a reason for each; runs in CI and calls no model.
- Alex
- brok
- Capitalize My Title
- case-police
- Corpus Keeper - Free Python CLI that checks Markdown folders for broken relative links, index drift, and stale markers while scaffolding document governance files.
- Doc Detective
- 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.
- Docs Link Integrity Checker - Checks local Markdown and HTML links, anchors, and paths offline; external URLs require an imported status report.
- EkLine
- Harper
- HtmlTest
- InnovationEngine
- Linkspector
- lychee
- mdoctest - Runs the code blocks and console sessions in Markdown docs and checks their output still matches, with
--fixto update them; language-agnostic and dependency-free. - Readable
- Rules example
- seiso - Markdown convention and linter for project docs written by AI and read by humans and agents. Checks document kinds, local links, facts restated across pages, values that go stale such as versions, and conversation remnants left in the page.
- Swimm
- Vale
- Woke
- Your automated tester
Reading
- A Guide to Creating Personas
- A simple technique for evaluating content
- An examination of translating text to make it as accessible as possible
- API Handyman
- Automating Your Accessibility Tests
- Awesome Documentation
- Become a better writer as a developer
- Become a technical writer
- Document Like a Scientist
- Free Resources to Learn Technical Writing
- Google - Technical Writing Courses
- Grammarly Blog
- Great Developer Documentation Examples
- How Google, Twitter, and Spotify built a culture of documentation
- How to write technical posts
- Mastering cURL
- Maybe it’s time we re-think docs
- Scottydocs.com
- Semantic Line Breaks
- Setting up the alex.js language linter in your project
- Systematic approach to technical documentation authoring
- Technical Writing: A Comprehensive Guide
- Technical Documentation in Software Development
- Technical Documentation Tool and Web Guide
- Trigpoint: Diátaxis - Four types of documentation: tutorial, how-to, reference and explanation, separated by reader needs.
- User Guide Template
- What nobody tells you about documentation
- Where to start with analytics for documentation
- Why does inclusive language matter
- Write good examples by starting with real code
- Writing great documentation
- Writing Technical Stuff for Non-Technical Readers
Screencast
Screenshot
- Allscreenshots - Hosted screenshot API for capturing web pages and docs as PNG, JPEG, WebP or PDF, with a free plan and a MkDocs plugin for generating OpenGraph images.
- Carbon
- CurlShot - Hosted screenshot API that captures web pages and docs as PNG, JPEG, WebP or PDF from a URL, with a free plan.
- Flameshot
- Heroshot
- ItsPaint (macOS)
- shot-scraper
- Shottr
Site Generators
- 11ty
- Antora
- adoc Studio
- Bengal
- Astro
- docmd
- Document Node
- Docus
- Docusaurus
- DocFX
- Docsify
- Docsite
- Dokz
- eziwiki - Markdown wiki and documentation site generator built on Next.js, with wikilinks, backlinks, and a graph view.
- Fumadocs
- Gridsome
- Log4brains
- mdBook
- MkDocs
- Nextra
- Nibleaf - Open-source platform for editing, publishing, searching, and self-hosting multilingual Markdown and MDX documentation.
- Portray
- Quarto
- Quartz
- RcPress
- Sphinx
- Sourcey - Open-source static documentation generator that builds native LLM-ready context directly from specs and markdown.
- VitePress
- Vocs
- VuePress
- xyd
- Zola
Docsify Extensions
Hugo Extensions
MkDocs Extensions
Search
Sphinx Extensions
Sphinx Themes
Spelling
Style Guides
- Accessibility - MDN Web Docs
- Accessible social media content
- Aiven
- Apple Style Guide
- Atlassian
- BBC
- Buffer
- CLI Guidelines
- Container terminology
- Datagrok
- Developer Style Guide
- DigitalOcean
- Federal (US) plain language guidelines
- GitHub
- GitLab
- Human words for technical docs
- Linode
- Mailchimp
- Markdown Guide
- Meta Analysis of 33 Style Guides
- Michigan State University
- Microsoft
- MongoDB
- Monzo
- Rackspace
- Red Hat Guidelines
- Red Hat Style Guide
- Salesforce
- Shopify
- Splunk
- Sprout
- The essential guide to conscious language
- The Writer
- United Nations
- Web Content Accessibility Guidelines
- Website Style Guide Resources
- Write The Docs
Tool Collection
- adr-tools
- AutomaDocs - AI documentation platform for GitHub repos. Tree-sitter AST chunking, Claude generation, hybrid retrieval (BM25 + Pinecone vector). Webhook-driven selective regeneration on every push so docs stay in sync with code.
- Awesome Design Tools
- Bluehawk
- Browser SOP Builder - Local-first browser tool for drafting controlled procedures and exporting Markdown without accounts or server storage.
- Calculate max length for UI elements
- Canopy - Architecture mapping and context exports for developer documentation.
- Code Hike
- CodeAlmanac - Self-updating repository wiki for AI coding agents that tracks project conversations and context locally in the repo.
- CSS+JS Code snippets for enhancing online documentation
- docToolchain
- DraftView - A visual review layer for docs-as-code projects. Let contributors edit rendered documentation through a GitHub-native workflow and sync changes back as pull requests.
- D2 Declarative Diagramming
- DIV Table Generator
- Driver.js
- Excel to Markdown - Browser-local converter for turning XLSX, XLS, and CSV data into Markdown tables for READMEs and documentation.
- fixred
- gatsby-theme-adr
- GitDiagram - Generates an interactive architecture diagram and written explanation of a GitHub repository, with Mermaid and PNG export for docs and READMEs.
- HTML to Markdown Converter - Browser-local converter for turning HTML headings, lists, links, blockquotes, and inline formatting into Markdown.
- Loom
- Mermaid Diagram Editor for Confluence - Confluence Cloud app for editing Mermaid diagrams by clicking on the diagram or in code, with both kept in sync. Free for sites with up to 10 users.
- Mermaid Editor for Confluence - Free Confluence Cloud app for writing Mermaid diagrams with a live preview as you type. Runs on Atlassian Forge, so diagram data stays in Atlassian.
- Mermaid Online - Browser-based Mermaid diagram converter for previewing diagrams and exporting PNG, SVG, JPG, WebP, and PDF assets for docs, READMEs, blogs, and slides.
- Markdoc
- markdown-doctest
- Merge Docs Pro
- Penpot
- PitchDocs - AI-powered documentation generator that scans codebases and produces marketing-ready READMEs, changelogs, and AI context files with quality scoring.
- Moxie Docs - SaaS GitHub App for living repository documentation: indexes codebases, generates docs, exposes AI agent context through MCP, and opens documentation PRs when docs drift from code.
- Playwright
- Pocket Marketing List
- readme.so
- rstcheck
- rundoc
- Shepherd
- Squoosh
- Sync-o - AI documentation automation for Atlassian. Auto-updates Confluence pages with surgical section-level diffs when Jira tickets transition to Done. EU-resident, GDPR-compliant.
- Tables Generator
- Tablesmit - A minimalist, open-source table builder for analytical writing. It helps create, format, and export structured tables for technical documentation.
- Tools for Technical Writers
- Trupeer - AI-powered tool that transforms screen recordings into polished product videos and step-by-step documentation.
- vendir
- Writerside
User Behavior Analytics
Viewer
- Glim - Mac Markdown viewer with Mermaid diagrams, LaTeX formulas and basic source editing.
- Glow - Render Markdown on the CLI
- MacMD Viewer - Native macOS Markdown viewer with Mermaid diagram support, QuickLook extension, and syntax highlighting for 190+ languages.
- mdv