awesome-repositories.com
Blog
MCP
awesome-repositories.com

Discover the best open-source repositories with AI-powered search.

ExploreCurated searchesOpen-source alternativesSelf-hosted softwareBlogSitemap
ProjectMCP serverAboutHow we rankPress
LegalPrivacyTerms
© 2026 Bringes Technology SRL·VAT RO45896025·hello@awesome-repositories.com
apidoc avatar

apidoc/apidocArchived

0
View on GitHub↗
apidocjs.com↗

Apidoc

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 use in external schemas or custom templates.

Beyond basic generation, the system supports custom documentation layouts, visibility filters for private or deprecated methods, and the ability to test live API endpoints directly from the generated interface. The workflow can be automated by monitoring source files for changes to trigger real-time regeneration.

The generator can be executed via a command-line interface, run programmatically as a library, or deployed using a Docker container.

AI search

Explore more awesome repositories

Describe what you need in plain English — the AI ranks thousands of curated open-source projects by relevance.

Start searching with AI

Features

  • API Documentation Generators - Automatically generates a searchable API documentation website from specialized source code annotations.
  • API Documentation Generators - Parses specialized annotations in source code to automatically generate a searchable API documentation website.
  • Static Site Templating - Transforms structured API data into searchable HTML websites using customizable layout templates.
  • Source Code Documentation Tools - Implements utilities that extract metadata from source code comments to automate the creation of technical API references.
  • Multi-Language API Documentation - Uses configurable regular expressions to parse API metadata across multiple programming languages for consistent documentation.
  • Source Comment Parsers - Extracts API definitions from various programming languages using configurable regular expression matching.
  • Automated API Documentation - Automatically generates searchable technical documentation by extracting API definitions directly from source code annotations.
  • Annotation Parsers - Uses a regex-based parsing system to extract API metadata from comments across various programming languages.
  • Regular Expression-Based Parsing - Uses regular expressions to parse API metadata from source code comments.
  • Document Output Customization - Offers customization of documentation layouts through grouping, manual ordering, and unique headers.
  • Static Site Generators - Transforms parsed API definitions and templates into a searchable static HTML website for web deployment.
  • Static-Site-Based Documentation - Generates a static web interface for browsing API endpoints and testing requests against live servers.
  • Data Export Generators - Exports extracted API definitions into raw JSON files for use in external tools.
  • API Definition Exporters - Converts source-code comments into raw JSON files for use in external schemas or custom templates.
  • Member Visibility Filtering - Controls endpoint visibility in the output using annotations for private or deprecated methods.
  • Source File Watching - Monitors source files for changes to trigger automatic documentation regeneration.
  • Documentation Automation - Includes a file-watching mechanism that triggers automatic regeneration of documentation whenever source files are updated.
  • Intermediate Representations - Uses a JSON intermediate representation to decouple API extraction from site rendering.
  • API Endpoint Testing - Provides an interface to execute sample requests and verify live API endpoint behaviors.
  • Documentation Layouts - Supports custom documentation layouts, grouping, and visibility filters to tailor the organization of the generated API reference.
  • Documentation Generators - Generates RESTful API documentation from source code annotations.
9,667 stars·1,635 forks·JavaScript·25 views

Star history

Star history chart for apidoc/apidocStar history chart for apidoc/apidoc

How this analysis was created: This summary and feature list are AI-generated from collected project material and can contain mistakes. Stars, license and language are imported from GitHub. Inclusion does not mean that we have tested or audited this project. Check the source documentation for any feature you depend on. Learn more on our About page.

Projects sharing features with Apidoc

These projects share indexed features with Apidoc. Shared tags can include platform or build tooling; verify the primary use case before treating a result as a replacement.
  • typestrong/typedocTypeStrong avatar

    TypeStrong/typedoc

    8,411View on GitHub↗

    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

    TypeScriptdocumentationgeneratortypescript
    View on GitHub↗8,411
  • tomaz/appledoctomaz avatar

    tomaz/appledoc

    4,189View on GitHub↗

    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

    Objective-C
    View on GitHub↗4,189
  • lord/slatelord avatar

    lord/slate

    36,082View on GitHub↗

    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

    View on GitHub↗36,082
  • kotlin/dokkaKotlin avatar

    Kotlin/dokka

    3,780View on GitHub↗

    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,

    Kotlinapi-referencedocumentationdokka
    View on GitHub↗3,780
Compare all 30 related projects→

Frequently asked questions

What does apidoc/apidoc do?

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.

What are the main features of apidoc/apidoc?

The main features of apidoc/apidoc are: API Documentation Generators, Static Site Templating, Source Code Documentation Tools, Multi-Language API Documentation, Source Comment Parsers, Automated API Documentation, Annotation Parsers, Regular Expression-Based Parsing.

Which projects share features with apidoc/apidoc?

Projects with overlapping indexed features include: typestrong/typedoc — TypeDoc is a documentation generator and AST analyzer that transforms TypeScript source code and comments into… tomaz/appledoc — Appledoc is an Objective-C documentation generator and static site generator that parses source code comments to… lord/slate — Slate is a static API documentation generator and developer documentation framework. It transforms API specifications… kotlin/dokka — Dokka is an extensible documentation engine designed to generate structured API reference materials for Kotlin… jsdoc/jsdoc — JSDoc is a JavaScript API documentation generator that parses comments in source code to produce structured… voltagent/awesome-claude-code-subagents — This project provides a framework for managing multi-agent systems, designed to automate complex software development,…