typedoc-hugo-theme

A Hugo compatible compatible TypeDoc theme.

What is does?

• Adds Hugo Front Matter variables in YAML format to pages.
• Writes _index.md files to folders to enable Branch Bundles.

Installation

npm install typedoc typedoc-plugin-markdown typedoc-hugo-theme --save-dev

Usage

$ npx typedoc --theme hugo [args]

Options

Please refer to typedoc-plugin-markdown.

Output

Example page

---
title: "Class: SomeClass"
slug: "module.someclass"
linkTitle: "SomeClass"
---

+ page contents

Example directory

classes
└─── _index.md
└─── ClassA.md
└─── ClassB.md

License

MIT