This repository contains examples of output generated using typedoc-plugin-markdown.
The following examples link directly to the typedoc generated output in this repository.
You can also explore the examples folder and view the typedoc.json file within each sub-folder to view the configuration for each example.
- Default options: Showcases the default output of the plugin.
- Customized UX options: Showcases how the UX can be customized.
- Single page modules: Showcases output with single page modules.
- Packages example: Showcases output for entrypointStrategy "packages".
- Customization example: Showcases how output can be customized with hooks and custom theme.
- typedoc-plugin-frontmatter: Showcases how frontmatter can be added to pages.
- typedoc-plugin-remark: Showcases how output can be parsed with Remark plugins.
- typedoc-github-wiki-theme: Showcases output on GitHub Wiki pages.
- typedoc-vitepress-theme (StackBlitz
↗️ ): Showcases output for VitePress docs generator. - docusaurus-plugin-typedoc (StackBlitz
↗️ ): Showcases output for Docusaurus docs generator.
If you would like to explore and configure yourself clone the repository locally:
git clone git@github.com:typedoc-plugin-markdown/typedoc-plugin-markdown-examples.git.cd typedoc-plugin-markdown-examples.npm install.npm run docs.