🏅 Generates extra raw html contents during typedoc compilation 👍
✅ 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
You can install this package in your typescript project as follows:
$ npm install @yookue/typedoc-plugin-raw-content --save-dev
Enjoy your coding journey with typedoc-plugin-raw-content
✌️
$ typedoc [TARGET] --plugin @yookue/typedoc-plugin-raw-content
typedoc.json
{
"plugin": [
"@yookue/typedoc-plugin-raw-content"
]
}
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[] |
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 similar to the sample above.
This project is under the MIT License.