@yookue/typedoc-raw-content NPM

@yookue/typedoc-raw-content

🏅 Generates extra raw html contents during Typedoc compilation 👍

Features

✅ Support hooking head.begin event

✅ Support hooking head.end event

✅ Support hooking body.begin event

✅ Support hooking body.end event

✅ Support hooking content.begin event

✅ Support hooking content.end event

✅ Support hooking sidebar.begin event

✅ Support hooking sidebar.end event

✅ Support hooking pageSidebar.begin event

✅ Support hooking pageSidebar.end event

✅ Support hooking footer.begin event

✅ Support hooking footer.end event

Quickstart

You can install this package in your typescript project as follows:

$ npm install @yookue/typedoc-raw-content --save-dev

Enjoy your coding journey with typedoc-raw-content. ✌️

Usage

Using in command line

$ typedoc [TARGET] --plugin @yookue/typedoc-raw-content

Using in typedoc.json

{
    "plugin": [
        "@yookue/typedoc-raw-content"
    ]
}

Options

Here are the available options, specified them in typedoc.json:

Render Event	Option Name	Value Type
head.begin	rawHeadBegins	string[]
head.end	rawHeadEnds	string[]
body.begin	rawBodyBegins	string[]
body.end	rawBodyEnds	string[]
content.begin	rawContentBegins	string[]
content.end	rawContentEnds	string[]
sidebar.begin	rawSidebarBegins	string[]
sidebar.end	rawSidebarEnds	string[]
pageSidebar.begin	rawPageSidebarBegins	string[]
pageSidebar.end	rawPageSidebarEnds	string[]
footer.begin	rawFooterBegins	string[]
footer.end	rawFooterEnds	string[]

Example

Take rawFooterEnds option as an example in typedoc.json:

{
    "hideGenerator": true,
    "rawFooterEnds": [
        "<div style='text-align: center'>Copyright &copy; 2024 Yookue Ltd. All rights reserved</div>"
    ]
}

Other options are all the same as the sample above.

Document

GitHub pages: https://yookue.github.io/typedoc-raw-content

License

This project is under the MIT License.

Website

Yookue: https://yookue.com

typedoc typedoc-plugin typedoc-raw-content

0.1.1

1 year ago

0.1.0

1 year ago