0.0.1 • Published 3 years ago
@pujitm/typedoc-plugin-pages v0.0.1
typedoc-plugin-pages
A TypeDoc plugin that lets you integrate your own pages into the documentation output
Forked from https://github.com/mipatterson/typedoc-plugin-pages
Roadmap
- Absolute path resolution for consistency across build systems
- Support for debug logs
Features
- 🔍 Search integration
- 🔗 Interpage hyperlinks
- 🎨 Integrated Theme
- 📑 Reflection Navigation Title Customization
Demo
You can view a live demo here.
Installation
$ npm install typedoc-plugin-pages --save-dev
Usage
See the Quick Start guide to get started.
Supported Versions of TypeDoc
This plugin is designed to work with as many versions of TypeDoc as possible. It has been tested with the versions 0.16.5
through 0.19.2
. If you are reporting an issue, please include the version of TypeDoc you are using the plugin with.
0.0.1
3 years ago