awesome-docs/README.md

# Awesome Docs [![Awesome](https://awesome.re/badge-flat2.svg)](https://awesome.re)

A curated list of awesome documentation tools.

*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](https://github.com/testthedocs/awesome-docs/blob/master/CONTRIBUTING.md) first.

Thanks to all [contributors](https://github.com/testthedocs/awesome-docs/graphs/contributors); you rock!

## Contents

- [Accessibility](#accessibility)
- [API](#api)
- [Browser Extensions](#browser-extensions)
- [Browser Testing](#browser-testing)
- [Code Testing](#code-testing)
- [Collaboration](#collaboration)
- [Editor](#editor)
- [Feedback](#feedback)
- [GitHub Actions](#github-actions)
- [Hosting](#hosting)
- [Mockup](#mockup)
- [Quality Assurance](#quality-assurance)
- [Style Guides](#style-guides)
- [Screencast](#screencast)
- [Screenshot](#screenshot)
- [Site Generators](#site-generators)
  - [MkDocs Extensions](#mkd-extensions)
  - [Sphinx Extensions](#sphinx-extensions)
  - [Sphinx Themes](#sphinx-themes)
- [Spelling](#spelling)
- [Tool Collections](#tool-collections)
- [Reading](#reading)
- [User Behavior Analytics](#user-behavior-analytics)
- [Viewer](#viewer)
- [Watching](#watching)

## Accessibility

- [AXE-CLI](https://github.com/dequelabs/axe-cli)
- [Pa11y](https://pa11y.org/)
- [Lumberjack](https://github.com/JakePartusch/lumberjack)
- [Contrastchecker](https://webaim.org/resources/contrastchecker/)
- [Image Alt text best practices](https://support.siteimprove.com/hc/en-gb/articles/115000013031-Accessibility-Image-Alt-text-best-practices)


## API

- [Postwoman](https://github.com/liyasthomas/postwoman)
- [Postman](https://www.getpostman.com/)
- [Swagger](https://swagger.io/)
- [Stoplight Studio](https://stoplight.io/studio/)
- [ReDoc](https://redocly.github.io/redoc/)
- [Redoc-Editor](https://github.com/pointnet/redoc-editor)
- [OpenAPI 3 CLI](https://github.com/Redocly/openapi-cli)
- [Spectral](https://stoplight.io/open-source/spectral/)
- [Speccy](https://github.com/wework/speccy)
- [swaggerui](https://github.com/flowchartsman/swaggerui)
- [widdershins](https://github.com/Mermade/widdershins)
- [RapiDoc](https://mrin9.github.io/RapiDoc/index.html)

## Browser Extensions

- [Grammarly](https://www.grammarly.com/)
- [LanguageTool](https://languagetool.org/)

## Browser Testing

- [Nightwatch.js](https://nightwatchjs.org/)
- [Puppeteer](https://github.com/GoogleChrome/puppeteer)
- [Selenium](https://www.seleniumhq.org/)

## Code Testing

- [Testing Markdown code examples](https://staticschool.com/blog/testing-markdown-code-examples/)

## Collaboration

- [Draft](https://draftin.com/)

## Editor

- [Mark Text](https://marktext.app/)
- [Visual Studio Code](https://code.visualstudio.com/)
- [HackMD](https://hackmd.io/) (Markdown Collaboration)

## Feedback

- [Papercups](https://github.com/papercups-io/papercups)

## GitHub Actions

- [Spellcheck Action](https://github.com/marketplace/actions/spellcheck-action)
- [DOCtor-RST](https://github.com/marketplace/actions/doctor-rst)
- [Run misspell with reviewdog](https://github.com/marketplace/actions/run-misspell-with-reviewdog)
- [Lighthouse CI Action](https://github.com/treosh/lighthouse-ci-action)
- [TOC Generator](https://github.com/technote-space/toc-generator)
- [Alex Action](https://github.com/theashraf/alex-action)
- [Vale](https://github.com/errata-ai/vale-action)

## Hosting

- [GitBook](https://www.gitbook.com/)
- [Netlify](https://www.netlify.com/)
- [Read The Docs](https://readthedocs.org/)

## Mockup

- [Imagineui](https://imagineui.github.io/en/)
- [Animockup](https://github.com/alyssaxuu/animockup)
- [Markmap](https://markmap.js.org/)
- [Excalidraw](https://excalidraw.com/)

## Quality Assurance

- [HtmlTest](https://github.com/wjdp/htmltest)
- [Alex](https://github.com/get-alex/alex)
- [brok](https://github.com/smallhadroncollider/brok)
- [Readable](https://www.webfx.com/tools/read-able/)
- [Capitalize My Title](https://capitalizemytitle.com/)

## Style Guides

- [Website Style Guide Resources](http://styleguides.io/)
- [Google](https://developers.google.com/style/)
- [Microsoft](https://docs.microsoft.com/en-us/style-guide/welcome/)
- [Mailchimp](https://styleguide.mailchimp.com/)
- [Michigan State University](https://msu.edu/course/be/485/bewritingguideV2.0.pdf)
- [Sprout](https://sproutsocial.com/seeds/writing/)
- [Linode](https://www.linode.com/docs/linode-writers-formatting-guide/)
- [DigitalOcean](https://www.digitalocean.com/community/tutorials/digitalocean-s-technical-writing-guidelines)
- [Salesforce](https://developer.salesforce.com/docs/atlas.en-us.salesforce_pubs_style_guide.meta/salesforce_pubs_style_guide/overview.htm)
- [United Nations](http://www.dgacm.org/editorialmanual/)
- [Splunk](https://docs.splunk.com/Documentation/StyleGuide/latest/StyleGuide/Howtouse)
- [Monzo](https://monzo.com/tone-of-voice/)
- [GitLab](https://design.gitlab.com/content/voice-tone/)
- [The Writer](http://www.thewriter.com/what-we-think/style-guide/)
- [Federal (US) plain language guidelines](https://plainlanguage.gov/guidelines/)
- [SUSE](https://documentation.suse.com/style/current/single-html/docu_styleguide/)
- [18F](https://content-guide.18f.gov/)
- [Rackspace](https://developer.rackspace.com/docs/style-guide/writing/)
- [Apple Style Guide](https://help.apple.com/applestyleguide/)
- [Red Hat Style Guide](https://stylepedia.net/style/)
- [The essential guide to conscious language](https://consciousstyleguide.com/)
- [Guidelines for Inclusive Language](https://www.linguisticsociety.org/resource/guidelines-inclusive-language)
- [GitHub](https://github.com/github/docs/blob/main/contributing/content-style-guide.md#content-style-guide-for-github-docs-)
- [Web Content Accessibility Guidelines](https://www.w3.org/TR/WCAG21/)
- [Accessibility | MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/Accessibility)
- [CLI Guidelines](https://clig.dev/)
- [Human words for technical docs](https://coda.io/@dave-connis/human-words-for-technical-docs)

## Screencast

- [Asciinema](https://asciinema.org/)
- [Peek](https://github.com/phw/peek)
- [Kap](https://github.com/wulkano/kap) (macOS)
- [Editly](https://github.com/mifi/editly)
- [Codio](https://present.readthedocs.io/en/latest/codio.html)
- [Terminalizer](https://github.com/faressoft/terminalizer)
- [Screenity](https://github.com/alyssaxuu/screenity)

## Screenshot

- [Carbon](https://carbon.now.sh)
- [Flameshot](https://github.com/lupoDharkael/flameshot)

## Site Generators

- [Antora](https://antora.org/)
- [Asciidoctor](https://asciidoctor.org/)
- [Docusaurus](https://docusaurus.io/)
- [DocFX](https://dotnet.github.io/docfx/)
- [Docsify](https://docsify.js.org/)
- [Docz](https://www.docz.site/)
- [Docsite](https://github.com/sourcegraph/docsite)
- [Gridsome](https://gridsome.org)
- [Log4brains](https://github.com/thomvaill/log4brains)
- [MkDocs](https://www.mkdocs.org/)
- [Portray](https://github.com/timothycrosley/portray)
- [Sphinx](https://www.sphinx-doc.org/en/master/)
- [VuePress](https://vuepress.vuejs.org/)
- [Monobase](https://github.com/framer/monobase)
- [Zola](https://www.getzola.org/)
- [MDBook](https://github.com/rust-lang/mdBook)
- [MDX-GO](https://github.com/jxnblk/mdx-go)
- [Gatsby Docs Kit](https://github.com/brainhubeu/gatsby-docs-kit)
- [Document Node](https://documentnode.io/)
- [RcPress](https://github.com/YvesCoding/rcpress)
- [11ty](https://www.11ty.dev/)

### MkDocs Extensions

- [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
- [Tooltipster Links Plugin](https://github.com/midnightprioriem/mkdocs-tooltipster-links-plugin)

### Sphinx Extensions

- [Sphinx Substitution Extensions](https://github.com/adamtheturtle/sphinx-substitution-extensions)
- [MyST](https://myst-parser.readthedocs.io/en/latest/using/intro.html)
- [consoletest](https://github.com/intel/dffml/blob/master/dffml/util/testing/consoletest/README.md)

### Sphinx Themes

- [Sphinx Themes](https://sphinx-themes.github.io/sphinx-themes.org/)
- [The Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/en/latest/)
- [Furo](https://github.com/pradyunsg/furo)

## Spelling

- [PySpelling](https://facelessuser.github.io/pyspelling/)

## Tool Collections

- [Tools for Technical Writers](https://github.com/heyawhite/tech-writing-tools)
- [Driver.js](https://github.com/kamranahmedse/driver.js)
- [Shepherd](https://github.com/shipshapecode/shepherd)
- [Squoosh](https://squoosh.app/)
- [Table Tag Generator](https://tabletag.net/)
- [Irregardless](https://irregardless.ly/)
- [Awesome Design Tools](https://github.com/goabstract/Awesome-Design-Tools)
- [rundoc](https://gitlab.com/nul.one/rundoc)
- [markdown-doctest](https://github.com/Widdershin/markdown-doctest)

## Reading

- [Document Like a Scientist](https://noti.st/karissapeth/g3vUiw/document-like-a-scientist)
- [Technical Documentation in Software Development](https://www.altexsoft.com/blog/business/technical-documentation-in-software-development-types-best-practices-and-tools/)
- [Free Resources to Learn Technical Writing](https://medium.com/@ann.green/free-resources-to-learn-technical-writing-7d642020cda9)
- [Writing great documentation](https://medium.com/@episod/writing-great-documentation-44d90367115a)
- [Scottydocs.com](https://scottydocs.com/)
- [Great Developer Documentation Examples](https://everydeveloper.com/developer-documentation-examples/)
- [API Handyman](https://apihandyman.io/)
- [What nobody tells you about documentation](https://www.divio.com/blog/documentation/)
- [Grammarly Blog](https://www.grammarly.com/blog/)
- [Setting up the alex.js language linter in your project](https://dev.to/unmock/setting-up-the-alex-js-language-linter-in-your-project-3bpl)
- [Automating Your Accessibility Tests](https://24ways.org/2017/automating-your-accessibility-tests)
- [How to Design Headings that Work in 10 Easy Steps](https://www.nanatoo.com/blog/how-to-design-headings-that-work-in-10-easy-steps)
- [Kayce](https://kayce.basqu.es/blog)
- [How to write technical posts](https://reasonablypolymorphic.com/blog/writing-technical-posts/)
- [Become a technical writer](https://www.instructionalsolutions.com/blog/become-a-technical-writer)
- [API Knowledge](https://postman-toolboxes.github.io/api-knowledge/)
- [Mastering cURL](https://dev.to/mkinoshita12/mastering-curl-going-from-junior-to-senior-level-debugging-skills-5d80)
- [User Guide Template](https://clickhelp.com/clickhelp-technical-writing-blog/user-guide-template/)
- [Google - Technical Writing Courses](https://developers.google.com/tech-writing)
- [Let's Get Intentional About Documentation](https://counting.substack.com/p/lets-get-intentional-about-documentation)
- [Awesome Documentation](https://github.com/vipulgupta2048/awesome-documentation)
- [Writing Technical Stuff for Non-Technical Readers](https://quickfix.es/2020/10/the-baseline/)
- [A Guide to Creating Personas](https://marvelapp.com/blog/creating-personas/)

## User Behavior Analytics

- [Clarity](https://clarity.microsoft.com/)

## Viewer

- [Glow - Render Markdown on the CLI](https://github.com/charmbracelet/glow)

## Watching

- [SmartBear](https://www.youtube.com/channel/UC3iDZqrLWQZ4dh8zn2rU9hA)