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

Latest commit

 

History

History
16 lines (12 loc) · 810 Bytes

README.md

File metadata and controls

16 lines (12 loc) · 810 Bytes
Raw

@wearerunes/typedoc-plugin

Custom Typedoc plugin for Natuna (Supports version 0.22+).

In this plugin, you can:

  1. Create custom sidebar (customNavigations)
  2. Import markdown (staticMarkdownDocs)
  3. Remove primary sidebar navigation (removePrimaryNavigation)
  4. Remove secondary sidebar navigation (removeSecondaryNavigation)
  5. Replace markdown files content (markdownFilesContentReplacement)

See the example live result in here.
To use it, see the example configuration for this plugin in here

Use issues tab in the Github repository to report bugs or request features or if you had any questions.

I tried my best to keep this plugin as simple as possible. I hope you enjoy this plugin!