This repository contains examples of output generated using typedoc-plugin-markdown.

The examples link directly to the typedoc generated output in this repository. You can also browse the respective directories and view the configuration of each example.

• default-example - showcases the default output of the plugin.
• customized-ux - showcases how the UX can be customized.
• single-page-modules - showcases output with single page modules.
• packages - showcases output for entrypointStrategy "packages".
• localization - showcases how output can be output in another language.
• customization - showcases how output can be customized with hooks and custom theme.

• frontmatter - showcases how frontmatter can be added to pages.
• remark - showcases how output can be parsed with Remark plugins.

If you would like to explore the examples and configure yourself clone the repository locally:

git clone [email protected]:typedoc2md/typedoc-plugin-markdown-examples.git
cd typedoc-plugin-markdown-examples

npm install

To run all examples:

npm run docs

To run a specific example:

npm run docs --workspace ux-options