typedoc-just-the-docs-theme

0.0.1 • Public • Published

typedoc-just-the-docs-theme

This theme is made to work with the jekyll theme just-the-docs. It also requires typedoc-plugin-markdown to work.

Supports TypeDoc 0.22.x

What is does?

Note this theme was not extensively tested and was made to cover a single use case.
  • Generates github well organized path directory
  • Append on each markdown page a YML front matter with specifies from just-the-docs.

Requirements

Usage

npm install typedoc-just-the-docs-theme --save-dev

On typedoc.json file.

{
  "theme": "just-the-docs"
}

Road map

  • [ ] Add tests

Package Sidebar

Install

npm i typedoc-just-the-docs-theme

Weekly Downloads

2

Version

0.0.1

License

Apache-2.0

Unpacked Size

19.4 kB

Total Files

7

Last publish

Collaborators

  • luizstacio