Open-source alternatives to Documentation

Swagger-jsdoc is a documentation utility that automates the creation of standardized interface specifications for web services and RESTful endpoints. It functions as a documentation builder that extracts metadata directly from source code comments and configuration files to maintain synchronized interface definitions alongside application logic. The tool parses code structures and merges disparate configuration files to produce machine-readable documentation that adheres to industry standards. By utilizing rule-based validation, it ensures that the generated output complies with formal struct

GitHub Corners is a collection of customizable web callout widgets designed to promote open source projects. It provides a lightweight UI component that acts as a visual link, directing website visitors to a project repository. The project allows for extensive style customization, enabling users to adjust colors and sizes to match a specific brand identity. These ribbons function as call-to-action elements to encourage users to view or fork source code. The system generates these graphics as scalable vector graphics through serverless image rendering. Visual styles and text content are deter

go-swagger is a toolkit for working with Swagger/OpenAPI 2.0 specifications in Go. It generates server, client, and CLI code from a specification document, and can also produce a specification by scanning annotated Go source code. The project includes a static validation engine that checks documents against the schema and project-specific rules, and a specification transformation pipeline that resolves, flattens, and merges documents. The toolkit generates both client and server code from the same specification, ensuring consistency in request and response handling. It also produces a command

Dokka is an extensible documentation engine designed to generate structured API reference materials for Kotlin projects. By parsing source code and comments, it functions as a static site generator that transforms codebases into readable documentation. It integrates directly into development workflows as a build system plugin, allowing for the automated creation of reference materials during the standard compilation process. The project distinguishes itself through a modular, plugin-driven processing pipeline that allows developers to modify the generation workflow, customize output formats,

waka-readme-stats is an automated profile README updater and developer statistics dashboard. It integrates with the WakaTime API and compatible self-hosted endpoints to synchronize time-tracking data, which it then transforms into a formatted display of coding hours, languages, and operating systems. The tool operates as a GitHub Action that fetches metrics and automatically updates a profile README file by replacing marker comments with dynamic content via git commits. It allows for custom API endpoint integration to support self-hosted services. The system provides capabilities for metrics

RAML is a declarative YAML-based specification language used for modeling RESTful interfaces and data structures. It functions as a contract-first API framework and modeling standard, establishing a formal agreement for service communication and a single source of truth before implementation begins. The specification enables the automation of functional mock servers and the generation of language-specific client SDKs directly from the definition files. It supports a modular approach to API design through the use of external libraries, overlays for extending contracts, and reusable traits and

This project is a responsive Sphinx documentation theme that provides a visual layout and a set of Jinja2 templates for rendering technical content into a consistent web interface. It functions as a CSS documentation framework designed to adapt the presentation of technical manuals for both desktop and mobile screens. The theme includes a structured layout specifically for software API references, formatting function signatures, parameters, and return types. It also provides integrated mechanisms for version control linking, allowing documentation pages to point directly to source files on ex

Markdown-toc is a utility for generating and maintaining tables of contents within markdown files. It functions as both a command-line interface and a programmatic library, enabling the automated creation of structured navigation links based on the heading hierarchy of a document. The tool distinguishes itself through its marker-based injection system, which allows for the precise placement and updating of navigation blocks within existing files. It includes a dedicated transformation pipeline for slugifying heading text into URL-friendly identifiers, ensuring that generated links remain cons

Docute is a browser-based documentation framework that transforms markdown files into functional websites directly within the user's browser. By performing all processing on the fly, it eliminates the need for static build steps, server-side compilation, or complex deployment pipelines. The platform functions as a single-page application, managing navigation and content updates dynamically by intercepting browser history events to avoid full page reloads. It utilizes a virtual file system abstraction to fetch and resolve documentation assets, ensuring that the site remains responsive and ligh

ESDoc - Good Documentation for JavaScript

Docs to Markdown is a free Google Docs add-on that converts a Google Doc to simple, readable Markdown or HTML text.

Docusaurus is a documentation framework and static site generator designed to transform markdown files and component templates into optimized web pages. It functions as a content management platform for technical knowledge bases, utilizing a build process that pre-renders content into static HTML and JavaScript bundles to ensure site performance and search visibility. The framework distinguishes itself through a component-driven architecture that allows developers to build unique page layouts and interactive elements using reusable code blocks. It employs file-system-based routing to map dire

Gitbook is a documentation-as-code platform designed for centralized technical knowledge management. It functions as a knowledge management system that synchronizes documentation files directly with version control repositories, allowing teams to maintain content alongside their source code. The platform distinguishes itself through an integrated artificial intelligence layer that provides context-aware search assistance and automated content suggestions. By utilizing block-based content modeling, it enables the construction of structured, modular documentation that can be compiled into stati

This project is a JavaScript optimizer, minifier, module bundler, transpiler, and static analysis tool. It provides a compilation pipeline designed to shrink file sizes and improve runtime performance. The system utilizes a multi-pass compilation process to perform dead code elimination, global name mangling, and static type inference. It identifies unreachable functions and unused variables to reduce the final output size and detects potential runtime errors without executing the code. The tool manages assets through dependency resolution, code chunking, and bundle management. It ensures co

:book: HonKit is building beautiful books using Markdown - Fork of GitBook

Ignite Modern markdown documentation generation.

Literate Programming can be Quick and Dirty.

An API documentation generator for JavaScript.

Slate is a static API documentation generator and developer documentation framework. It transforms API specifications and text files into a formatted static website designed for hosting API references and guides. The system functions as a static site generator that builds a developer portal without the need for a backend database. It manages API reference details by organizing technical endpoints into a readable format and providing a structured layout for developer consumption. The framework covers content generation and site architecture, including the compilation of markdown guides and th

Managing environment variables across different frameworks and environments is painful:

Angular expressions support for easy-template-x

api-blueprint is a markdown-based API design language and specification standard used to define the structure, behavior, and data schemas of HTTP web services. It provides a formal method for mapping HTTP methods to resources and defining payload validation rules through a machine-readable syntax. The project functions as a blueprint for creating interactive technical documentation and functional mock servers. These tools transform design specifications into human-readable guides and simulated backend environments to enable integration testing before implementation. The language covers API m

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

Codo is a CoffeeScript API documentation generator, similar to YARD. Its generated documentation is focused on CoffeeScript class syntax for classical inheritance.

Simple API Documentation Generator.