@knodes/typedoc-plugin-monorepo-readmes v0.23.1

@knodes/typedoc-plugin-monorepo-readmes

A TypeDoc plugin to prepend modules indexes with readmes

For more infos, please refer to the documentation

Features

• 🎨 Compatible with the default theme
• 📁 Built for monorepos
• 🎯 Compatible with @knodes/typedoc-plugin-pages indexes

Usage

Simply create README.md files next to your package.json in your monorepo projects/workspaces.

You can configure file names to search to get the workspace root with the pluginMonorepoReadmes:rootFiles option.

Example: for NX Monorepo, set it to ["project.json", "package.json"] to correctly match both libraries & root. You could even use "pluginMonorepoReadmes:rootFiles": ["README.md"] to match the closest README.md file in any parent directory.

Note that rootFiles are case-sensitive.

Configuration

For more information on configuration, please refer to the options documentation page

Quick start

npm install --save-dev @knodes/typedoc-plugin-monorepo-readmes typedoc@^0.23.0

Compatibility

This plugin version should match TypeDoc ^0.23.0 for compatibility.

Note: this plugin version was released by testing against ^0.23.8.