What software do you use to write documentation?

This page summarizes the projects mentioned and recommended in the original post on /r/learnprogramming

Our great sponsors
  • Appwrite - The open-source backend cloud platform
  • InfluxDB - Collect and Analyze Billions of Data Points in Real Time
  • Revelo Payroll - Free Global Payroll designed for tech teams
  • Sonar - Write Clean JavaScript Code. Always.
  • Onboard AI - Learn any GitHub repo in 59 seconds
  • obsidian-releases

    Community plugins list, theme list, and releases of Obsidian.

    obsidian.md is a very powerful markdown editor that you can use and they have a publish online feature too

  • Docusaurus

    Easy to maintain open source documentation websites.

    I think this is what you might be looking for - docusaurus

  • Appwrite

    Appwrite - The open-source backend cloud platform. The open-source backend cloud platform for developing Web, Mobile, and Flutter applications. You can set up your backend faster with real-time APIs for authentication, databases, file storage, cloud functions, and much more!

  • spectaql

    Autogenerate static GraphQL API documentation

    I've also used spectaql before to auto generate graphql docs.

  • mkdocs-material

    Documentation that simply works

    The Material theme is really great, has great features. https://github.com/squidfunk/mkdocs-material

  • MkDocs

    Project documentation with Markdown.

    I use mkdocs: https://www.mkdocs.org/

  • typedoc

    Documentation generator for TypeScript projects.

    Docusaurus has a Typedoc plugin. Also there is a typedoc markdown plugin.

  • pandoc

    Universal markup converter

    Tried mkdocs and it is great; beautiful styling and both Markdown and reStructuredText can be used. It would be perfect if I could figure out a way to replace the Markdown -> HTML converter (probably python-Markdown?) with pandoc

  • InfluxDB

    Collect and Analyze Billions of Data Points in Real Time. Manage all types of time series data in a single, purpose-built database. Run at any scale in any environment in the cloud, on-premises, or at the edge.

  • mdBook

    Create book from markdown files. Like Gitbook but implemented in Rust

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a more popular project.

Suggest a related project

Related posts