typedoc-plugin-pages-fork-fork
v0.0.3
Published
A TypeDoc plugin that lets you integrate your own pages into the documentation output
Downloads
2,029
Maintainers
Readme
typedoc-plugin-pages
Fork of the fork ¯_(ツ)_/¯
First fork fixes support for newest typedoc, this fork fixes
- crash when there is nothing to generate from the code - just tutorial files
- building & publishing
Partial mapped could not be found
on some specific code
A TypeDoc plugin that lets you integrate your own pages into the documentation output
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.