typedoc-plugin-navigation-title

Table of contents

• 🍵 Introduction
• 🚀 Get started
• 🧬 Types
  • Reflection
• 🧰 TSDoc configuration
• 🤝 Contribute
• 👑 Author
• ⚖️ License
• 📰 Changelog
• 🧱 Related packages

🍵 Introduction

This plugin depends on typedoc-plugin-navigation-hooks experimental plugin.

It adds support for @navigationTitle JSDoc tag to manually set the title displayed in the navigation for a reflection.

Just add tag to the comment:

/**
 * @navigationTitle Awesome foo!
 */
export function foo () {}

If foo has its own page and navigation item, the title displayed in navigation will be "Awesome foo!".

Note that the reflections will have the _navigationTitle property set. See Reflection type below.

🚀 Get started

npm install -D typedoc-plugin-navigation-title

Add the plugins in your typedoc.config.js file:

// typedoc.config.js

export default {
  entryPoints: [
    './src/index.ts'
  ],
  plugin: [
    'typedoc-plugin-navigation-hooks',
    'typedoc-plugin-navigation-title'
  ]
}

💡 You don't need to add "@navigationTitle" to TypeDoc blockTags option

Let's run the typedoc command!

🧬 Types

Reflection

export interface Reflection extends TypeDoc.Reflection {
  /**
   * The title to display in navigation
   */
  _navigationTitle?: string
}

🧰 TSDoc configuration

If you use a tsdoc.json configuration file in your project, you can extend your own config with this plugin TSDoc config file:

// tsdoc.json
{
  "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
  "extends": [
    "@microsoft/api-extractor/extends/tsdoc-base.json",
    "typedoc/tsdoc.json",
    "typedoc-plugin-navigation-title/extends/tsdoc.json"
  ]
}

👀 See also the TypeDoc tags documentation.

🤝 Contribute

You would like to contribute to this project? You are welcome!

First, please check:

• the contribution guide
• the code of conduct

👑 Author

Made with ❤ by Hervé Perchec

⚖️ License

GPL-3.0-only

📰 Changelog

See all changes to this project in the CHANGELOG.md file.

🧱 Related packages

• typedoc
• typedoc-plugin-navigation-hooks

README.md - this file was auto generated with juisy README templater. Don't edit it.