github-starred/awesome-docs
2
0
Fork 0
mirror of https://github.com/testthedocs/awesome-docs.git synced 2026-11-08 02:17:52 -06:00
Code Issues 364 Packages Projects Releases Wiki Activity
446 Commits 3 Branches 0 Tags
main
T
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE

README.md

Awesome Docs Awesome

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

  • 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

Hosting

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

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 --fix to 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

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

Docsify Extensions

Hugo Extensions

MkDocs Extensions

Search

Sphinx Extensions

Sphinx Themes

Spelling

Style Guides

Tool Collection

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

Watching

Writing

Reference in New Issue View Git Blame Copy Permalink
S
Description
No description provided
awesome
Readme
988 KiB
Languages
Markdown 100%