Skip to content
This repository has been archived by the owner on Feb 11, 2021. It is now read-only.

Latest commit

 

History

History
31 lines (19 loc) · 1.06 KB

README.md

File metadata and controls

31 lines (19 loc) · 1.06 KB
Raw

typedoc-plugin-pages

A TypeDoc plugin that lets you integrate your own pages into the documentation output

npm build

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.