@yookue/typedoc-raw-content v0.1.1
@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 © 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