Iconify Navigation Links
A plugin for TypeDoc that replaces navigation links in the default theme with iconify icons.
Installation
npm install -D typedoc-plugin-iconify-navigation-links
Example
In the top right of this page the GitHub link has been replaced with an icon from iconify (ant-design:github-filled).
See iconify for more.
Options
The following options are added to TypeDoc when the plugin is installed:
| Option | Type | Default | Description |
|---|---|---|---|
| iconifyNavigationLinks | Record<string, string> | {} |
The navigation links to have their text be replaced with iconify icons. The key is the link text as set in navigationLinks and the value is the icon to be used. |
| iconifyNavigationLinksFontSize | string | 1.25em |
The font size of the icons in the navigation links. |
| iconifyNavigationLinksTooltips | boolean | false |
Whether or not to show tooltips when hovering over the icons in the navigation links. |
Other Plugins
Check out my other plugins here.