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
  • SurveyJS - Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App
  • WorkOS - The modern identity platform for B2B SaaS
  • InfluxDB - Power Real-Time Data Analytics at Scale
  • 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

  • SurveyJS

    Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.

    SurveyJS logo
  • 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

  • WorkOS

    The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

    WorkOS logo
  • 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