Examples: typedoc-plugin-markdown

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

Index of Examples

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.

Core Output

Example Link	Description
Default Options	Highlights how the plugin behaves with default settings.
Display Options	Demonstrates how to adjust the user experience with custom display options.
Single Page Modules	Shows how documentation can be generated with a single module per page.
Single Page Docs	Shows how docs can be generated to a single file with a single entry point.
Packages	Illustrates the output for the "packages" entrypoint strategy.
Localization	Shows how to localize the plugin output to different languages.
Customization	Demonstrates advanced customization using hooks and custom themes.

Utils

Example Link	Description
Frontmatter	Showcases how frontmatter can be added to pages.
Remark	Showcases how output can be parsed with Remark plugins.

Running Examples Locally

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

1. Clone Repository

git clone git@github.com:typedoc2md/typedoc-plugin-markdown-examples.git
cd typedoc-plugin-markdown-examples
git submodule update --init --recursive

2. Install Dependencies

npm install

3. Build Examples

To run all examples:

npm run docs

To run a specific example:

npm run docs --workspace display-options