plugin-pages

@knodes/typedoc-plugin-pages

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

---

Compatibility

This plugin version should match TypeDoc ^0.22.0 for compatibility.

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

Quick start

npm install --save-dev @knodes/typedoc-plugin-pages typedoc@^0.22.0

For more infos, please refer to the documentation

NOTE: This plugin is based on typedoc-plugin-loopingz-pages, which is in turn a fork of typedoc-plugin-pages. Integrating it in this monorepo should (I hope) make easier maintainance.

Features

• 🔍 Search integration
• 🔗 Interpage hyperlinks
• 🎨 Compatible with the default theme
• 📁 Monorepo support
• 🎯 Locate invalid markups

Usage

In any markdown content, you can use the {@page ...} macro to lookup for pages.

Syntax:

{@page <path-to-file>[ link label]}

• <path-to-file>: A path to the desired page. The page resolution is as follow:
  • If the path starts with a ., search from the current file.
  • If the path starts with ~~/, search from the project root.
  • If the path starts with ~[....]/, search from the module/workspace with the given name.
  • Otherwise, the page is searched from the current module/workspace (or the project root).
• [ link label]: allow to specify the text in the link.

Module/workspace/project resolution first tries to search in the pages subfolder. You can customize this setting with the source option.

Configuration

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