Naughty Pinching Mannequins

    @knodes/typedoc-plugin-pages
    TypeScript icon, indicating that this package has built-in type declarations

    0.23.1 • Public • Published

    @knodes/typedoc-plugin-pages

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

    npm version npm downloads Compatible with TypeDoc


    CircleCI Code Climate coverage Code Climate maintainability

    For more infos, please refer to the documentation

    Features

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

    Usage

    1. Create markdown files into your repository (by default in the pages directory).
    2. Configure your pages tree in the typedoc configuration. Example:
      {
      	"pluginPages": {
      		"pages": [ { "title": "My project title", "moduleRoot": true, "children": [
      			{ "title": "Some cool docs", "source": "cool-docs.md" },
      			{ "title": "Configuration", "childrenDir": "configuration", "children": [
      				{ "title": "Configuration file", "source": "file.md" },
      				{ "title": "CLI options", "source": "cli.md" },
      			] },
      		] } ]
      	}
      }
      See the pages tree guide, or the options documentation page for more infos.
    3. In any markdown content (in README, pages, or doc comments), use the {@page ...} tag to create a link to a page.

    Syntax:

    {@page <path-to-file>[ link label]}
    • <path-to-file>: A path to the desired page. Checkout this documentation page for more infos on the syntax of the path.
    • [ link label]: allow to specify the text in the link. If not set, the target page title is used.

    Quick start

    npm install --save-dev @knodes/typedoc-plugin-pages 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.

    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 maintenance.

    Install

    npm i @knodes/typedoc-plugin-pages

    DownloadsWeekly Downloads

    1,651

    Version

    0.23.1

    License

    MIT

    Unpacked Size

    164 kB

    Total Files

    100

    Last publish

    Collaborators

    • gerkin