Open-source alternatives to Sphinx

TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into structured API reference websites or data files. It functions as a static site generator that converts code symbols into a searchable web interface. The project is an extensible framework, allowing users to modify the documentation process and generator logic through a programmable plugin system and custom themes. Its capabilities include API reference generation, source code parsing, and documentation coverage validation to ensure exported members are properly described. It support

apidoc is a source-code API documentation generator that parses specialized annotations within comments to automatically create a searchable API documentation website. It functions as an annotation-based API parser and a static documentation site generator, extracting definitions directly from the codebase to maintain a synchronized reference. The tool is designed as a multi-language parser, using configurable regular expressions to extract metadata from various programming languages. It can also serve as a JSON API definition exporter, converting source-code comments into raw JSON files for

Compodoc is a TypeScript API documentation generator, static site generator, and project architecture visualizer. It parses source code and JSDoc comments to create searchable technical reference sites, API catalogues, and standalone HTML pages. The project distinguishes itself by analyzing import statements to produce dependency graphs and module maps that illustrate the structural relationships within a codebase. It includes specialized support for visualizing Angular projects, NestJS workflows, and Stencil web components, and can embed live working demos directly into documentation pages.

AndroidNote is a technical knowledge base and reference resource for Android development. It provides comprehensive guidance on application architecture, custom view development, and advanced graphics programming. The project is distinguished by its depth in visual implementation, covering pseudo-3D perspective projections via virtual cameras and complex 2D rendering using Bézier curves and PorterDuff color blending. It also provides detailed methodologies for app modularization and the management of internal libraries through private Maven repositories and JitPack. The reference surface ext

Grav is a flat-file content management system that eliminates the need for a traditional database by storing site content and configuration in human-readable Markdown and YAML files. Built as a modular PHP web framework, it uses a hierarchical page routing system where the physical directory structure directly determines the site's URL paths. The platform is distinguished by its event-driven plugin architecture and a command-line interface that prioritizes system administration, deployment, and maintenance tasks. It utilizes a blueprint-driven system to generate administrative forms from stru

Jupyter Book is a computational book publisher and static site generator that converts Jupyter notebooks and markdown files into interactive web books and publication-quality PDF documents. It serves as a markdown-based documentation tool that executes embedded code at build time and caches the resulting outputs for static display. The system distinguishes itself by supporting interactive data publications, allowing readers to engage with live computational widgets and launch notebooks in remote execution environments. It extends standard markdown with a system of roles and directives to supp

Gollum is a Git-powered wiki engine and content management system that provides a web-based interface for editing and organizing files stored in a Git repository. It functions as a self-hosted documentation tool, using a Git-based storage backend to manage page content and track version history. The system is characterized by a pluggable markup rendering architecture that converts multiple markup languages and specialized notations into HTML. It supports a wide array of rich content, including mathematical typesetting, BibTeX bibliographies, and diagrams rendered via Mermaid. Broad capabilit

JSDoc is a JavaScript API documentation generator that parses comments in source code to produce structured documentation files for a project interface. It functions as a source code documentation tool that extracts metadata from code comments to automate the creation of technical API references. The system operates as a template-based documentation engine, supporting external templates to customize the visual presentation and layout of the output. It also serves as a Markdown documentation exporter, transforming extracted documentation into Markdown files for use on alternative publishing pl

This project is the official Kubernetes documentation website, serving as a comprehensive technical resource for managing containerized applications. It functions as an open-source technical documentation portal that provides guides, tutorials, and reference materials for distributed systems software. The site is built using a static site generator with a component-based template architecture to maintain consistent design patterns. It features an OpenAPI documentation generator that parses technical specifications to automatically build and update structured API reference pages. To support a

springdoc-openapi is a library and toolset that analyzes Spring applications at runtime to produce machine-readable OpenAPI specifications in JSON and YAML formats. It serves as an integrator that extracts API metadata from Java source code and annotations to automate documentation for Spring-based services. The project distinguishes itself through its ability to aggregate API specifications from multiple remote microservices into a single unified interface and provide multiple visualization options, including Swagger UI and Scalar. It also offers a dedicated plugin for exporting documentatio

Showdoc is a technical documentation platform and knowledge management system designed to centralize project specifications, internal manuals, and technical guides. Built as a PHP web application, it provides a collaborative environment for teams to organize and share information across software development organizations. The platform distinguishes itself through its ability to automate documentation workflows by parsing source code comments and synchronizing technical records with the current state of a codebase. It also features specialized tools for managing RESTful API documentation and g

rmarkdown is a dynamic document generator and markdown rendering engine used to create reproducible reports, analysis, and websites. It functions as a literate programming tool that weaves narrative text with live executable code and data, ensuring that visual results are tied directly to the source code. The project serves as a multi-format rendering engine and content publisher, utilizing a Pandoc-based conversion framework to transform a single source file into diverse outputs such as PDFs, HTML pages, and presentation slides. It integrates with Knitr to execute code blocks and capture out

VuePress is a Vue-powered static site generator and markdown-based documentation tool. It transforms markdown files into static HTML pages, serving as a modular website builder that leverages Vue components for rendering and theme injection. The project is distinguished by a plugin-based architecture that allows the build process and runtime to be extended. It features a specialized framework for transforming static content into Progressive Web Apps with service worker integration for offline support. The system covers a broad range of capabilities, including internationalization for multi-l

Asciidoctor is a Ruby-based text processing engine and command-line toolchain designed to convert AsciiDoc content into structured publishing formats, including HTML5 and DocBook 5. It functions as a static content publishing toolchain that transforms raw source files into formatted documents. The system utilizes a pluggable converter interface and template-driven output, allowing the default conversion logic to be overridden via custom converters or templates. This enables the generation of specific document structures and the export of content into various publishing formats for diverse dis

This project is a technical writing style guide and comprehensive specification for professional documentation, with a primary focus on standards for Chinese technical prose. It provides a structured framework for organizing document hierarchies, software manuals, and API references to ensure a consistent user experience. The guide distinguishes itself through detailed linguistic specifications, including rules for integrating English terms into non-English text and precise standards for punctuation, spacing, and grammar tailored for the Chinese language. It also defines quantitative formatti

SoftwareCopyright-Skill is a software copyright application generator and documentation tool designed to automate the creation of registration materials and operation manuals. It analyzes local project source code to produce formatted documents and source code extracts required for official software copyright filings. The project synthesizes software operation manuals by translating project business logic and technical features into descriptive functional text. It utilizes template-based generation to inject extracted project data into standardized Word documents, facilitating the creation of

This project is a software engineering playbook providing a collection of standardized guidelines and processes for managing the full software development lifecycle and team operations. It serves as a high-level framework for organizing agile project management, API design, containerized development standards, and markdown documentation workflows. The framework establishes a system for language-agnostic API design to automate client library generation and documentation. It also defines standards for providing uniform contributor environments and toolchains through virtualized containers. The

This project is a diagram-as-code tool that transforms declarative text scripts into professional visual representations. It functions as a technical documentation generator, allowing users to define nodes, connections, and hierarchical relationships through a domain-specific modeling language that integrates directly into version-controlled developer workflows. The tool distinguishes itself through a highly modular architecture that decouples diagram definitions from spatial positioning. It features a pluggable layout engine that supports multiple arrangement algorithms, alongside a styling

RenderCV is a command-line utility designed to transform structured YAML data into professionally typeset documents. By separating content from presentation, it allows users to maintain version-controlled resumes that are automatically rendered into high-quality PDF, HTML, and Markdown formats. The system leverages a specialized typesetting engine to ensure precise layout control and professional-grade typography. The project distinguishes itself through a schema-driven approach that enforces strict data validation, ensuring that input files are error-free before processing. Users can customi

This project is a markdown syntax cheatsheet and reference guide designed for writing documents with a focus on GitHub Flavored Markdown. It serves as a formatting reference and documentation template for creating technical content and project landing pages. The guide provides a comprehensive collection of examples for GitHub specific extensions, including task lists and callout alerts. It functions as a visual directory for implementing structured layout elements such as tables, mathematical equations, and code blocks. The reference covers broad capability areas including content and media

CodeMirror is a browser-based code editor and extensible text editor framework. It functions as a programmable interface for rendering code and text with support for numerous programming languages, serving as a reusable component for web-based integrated development environments. The project provides a syntax highlighting engine that applies visual styles to text based on programming language rules. It includes a programming API and a CSS theming system to customize the editor's appearance and extend its functionality with custom behaviors. The framework covers capabilities for embedding tex

Atom is an extensible code IDE and hackable text editor designed for source code editing and the creation of custom development environments. It functions as a syntax highlighting editor and a version control integrated editor that tracks file changes and synchronizes code with remote repositories. The editor allows for the modification of its own core functionality and supports a package-based plugin system for creating custom themes and snippets. It also serves as a Markdown preview editor, providing side-by-side visual rendering for content authoring. The platform includes capabilities fo

Mindoc is a self-hosted documentation portal and API documentation management system built as a Golang web application. It serves as a markdown documentation engine for authoring, organizing, and sharing technical interface documentation and database dictionaries. The system persists project data and user accounts using MySQL or SQLite databases. The platform distinguishes itself by integrating diagrams-as-code rendering via Mermaid syntax, allowing flowcharts, sequence diagrams, and Gantt charts to be generated directly from text. It supports a flexible content pipeline that combines markdow

Typecho is a self-hosted PHP blogging platform and content management system designed for publishing blogs and journals. It functions as a multi-database CMS, providing a writing interface that converts lightweight markup language into formatted HTML for streamlined article authoring. The platform is built as a plugin-based system, allowing users to extend functionality and modify site behavior through third-party extensions. Site appearance and layout are managed through a customizable theme system. The system includes capabilities for managing content via custom data fields and supports da

Knowledge Repo is a technical content management system designed for organizing and sharing research, professional guides, and technical documentation. It functions as a collaborative technical wiki and knowledge base that supports the curation of insights using notebooks and markdown files. The platform synchronizes with version control to automate content publishing by detecting commits and changes pushed to a connected Git repository. This integration allows the system to manage markdown content and technical posts through a version-control-integrated workflow. The system includes tools f

Hug is a type-driven Python web framework designed for building APIs. It uses Python type annotations to automatically validate and convert incoming request data and to format outgoing responses. The framework functions as an automated documentation tool by extracting function signatures and markers from source code to generate accessible API specifications. It also supports non-blocking coroutines for asynchronous API processing to handle background tasks without interrupting the main request cycle. The project provides capabilities for REST API development, including route mapping, endpoin

Appledoc is an Objective-C documentation generator and static site generator that parses source code comments to create structured HTML documentation sets. Its primary purpose is to generate professional developer reference guides that adhere to official Apple style documentation. The tool distinguishes itself by integrating directly into the project compilation process via automated build-phase scripts, ensuring that technical guides are updated as code changes. It provides extensive customization through external HTML and CSS templates, as well as a property list configuration system to man