typedoc-plugin-markdown

The typedoc-plugin-markdown ecosystem allows you to generate TypeScript API documentation as Markdown using TypeDoc.

To use this project, you should start by installing the core plugin, typedoc-plugin-markdown, which handles the primary Markdown output. Depending on your documentation hosting platform or workflow, you can then add specialized packages to enhance the output with frontmatter, remark transforms, or specific themes for static site generators and wikis.

The typedoc-docusaurus-theme is a TypeDoc plugin specifically designed to generate documentation output compatible with Docusaurus. It simplifies the integration process by providing several key features:

• Additional TypeDoc Options: It exposes specialized configuration options to TypeDoc that are tailored for Docusaurus.
• Markdown Presets: It automatically applies relevant typedoc-plugin-markdown configuration settings to ensure the generated Markdown files work correctly within a Docusaurus environment.
• Sidebar Generation: It automatically generates a Docusaurus sidebar file (e.g., sidebar.js or sidebar.json) based on your TypeDoc structure, saving you from manual maintenance.

The typedoc-vitepress-theme is a plugin designed to make TypeDoc output compatible with VitePress. It performs two primary functions:

1. Anchor Compatibility: It updates internal Markdown anchors to ensure they work correctly within the VitePress routing and link model.
2. Sidebar Generation: It automatically generates VitePress-compatible sidebar data that can be imported and referenced in your VitePress configuration.

This plugin is intended for scenarios where TypeDoc is executed as a separate process from VitePress, but the resulting Markdown files need to integrate seamlessly into a VitePress-based documentation site.

The typedoc-vitepress-theme is a theme designed specifically to target VitePress as the output format for TypeDoc documentation. It simplifies the integration process by providing several automated features:

• Additional TypeDoc Options: It exposes specialized configuration options to TypeDoc to better suit VitePress requirements.
• Option Presets: It automatically applies relevant typedoc-plugin-markdown settings so you don't have to configure them manually.
• Sidebar Generation: It automatically generates a sidebar.json file to facilitate navigation within your VitePress site.

The typedoc-plugin-markdown is a plugin for TypeDoc that changes the default HTML output to Markdown. This allows you to integrate your TypeScript API documentation into various ecosystems like code repositories, wikis, and static site generators (SSGs).

Key features include:

• Support for CommonMark, GFM, and MDX-compatible Markdown.
• Compatibility with other TypeDoc plugins.
• Configurable output directory structures.
• Support for companion plugins (frontmatter, remark transforms) and companion themes (Docusaurus, VitePress, GitHub Wiki, and GitLab Wiki).

The typedoc-github-wiki-theme is a theme designed specifically to target GitHub Wiki output. It works by extending TypeDoc with several specialized features:

• Additional TypeDoc Options: It exposes extra configuration options to TypeDoc to better suit Wiki requirements.
• Configuration Presets: It automatically applies relevant typedoc-plugin-markdown options so you don't have to configure them manually.
• Sidebar Generation: It automatically generates a _sidebar.md file required for GitHub Wiki navigation.

The typedoc-gitlab-wiki-theme is a specialized theme designed to format TypeDoc output specifically for GitLab Wikis. It automates the preparation of wiki-compatible documentation by providing three main capabilities:

1. Additional TypeDoc Options: It exposes specific configuration options tailored for GitLab's environment.
2. Markdown Presets: It automatically configures relevant typedoc-plugin-markdown options to ensure the generated Markdown is compatible with GitLab Wiki rendering.
3. Sidebar Generation: It automatically generates a sidebar.md file, which GitLab uses to create the wiki navigation structure.

The typedoc-vitepress-theme provides two primary integration features:

1. Anchor Compatibility: It updates internal Markdown anchors to match the format expected by VitePress.
2. Sidebar Generation: It automatically generates a VitePress-compatible sidebar data structure that can be imported and referenced directly within your VitePress configuration.

The docusaurus-plugin-typedoc allows you to run TypeDoc as part of the standard Docusaurus toolchain. This means your API documentation is generated automatically during the normal Docusaurus dev and build flows, rather than requiring a separate manual command.

Internally, the plugin leverages typedoc-docusaurus-theme to ensure the generated Markdown and sidebar data are compatible with Docusaurus.

The typedoc-plugin-frontmatter plugin allows you to inject YAML frontmatter into the Markdown files generated by typedoc-plugin-markdown. This is useful for documentation systems (like Docusaurus, VitePress, or Nextra) that require page metadata such as titles, slugs, sidebar labels, or custom data to render pages correctly.

Key capabilities include:

• Global Frontmatter: Apply a set of variables to every generated Markdown page.
• Page-Specific Configuration: Use comment tags within your TypeScript source code to configure frontmatter for specific pages.
• Customization: Extend or modify frontmatter using a local plugin.

The typedoc-github-wiki-theme is a plugin for typedoc-plugin-markdown that adapts the output specifically for GitHub Wikis. It automates the following tasks:

• Wiki-friendly file names: Generates filenames that follow GitHub Wiki conventions.
• URL compatibility: Updates internal links to use formats compatible with GitHub Wiki navigation.
• Sidebar generation: Automatically writes a _Sidebar.md file to enable sidebar navigation within the wiki.