-
Notifications
You must be signed in to change notification settings - Fork 175
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: Refactored and updated code comments
- Loading branch information
Showing
150 changed files
with
6,438 additions
and
2,308 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
"typedoc-plugin-markdown": patch | ||
--- | ||
|
||
- Expose theme hooks similar to default theme. | ||
- Expose TypedDoc media and include syntax. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
"docusaurus-plugin-typedoc": patch | ||
"typedoc-github-wiki-theme": patch | ||
"typedoc-gitlab-wiki-theme": patch | ||
"typedoc-vitepress-theme": patch | ||
--- | ||
|
||
- Update core package dependency |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
# Custom Theme | ||
|
||
If required the theme can be further extended using recommended patterns of the HTML theme - please see TypeDoc's [custom theme](https://github.com/TypeStrong/typedoc/blob/master/internal-docs/custom-themes.md) docs. | ||
|
||
This approach can be implemented in this example showing how the header and footer templates can be customized with a new theme using a customn plugin. | ||
|
||
```ts filename="custom-plugin.ts" | ||
import { Application, PageEvent, Reflection } from "typedoc"; | ||
import { | ||
MarkdownTheme, | ||
MarkdownThemeRenderContext, | ||
} from "typedoc-plugin-markdown"; | ||
|
||
export function load(app: Application) { | ||
app.renderer.defineTheme("custom-markdown-theme", CustomTheme); | ||
} | ||
|
||
class CustomMarkdownTheme extends MarkdownTheme { | ||
override getRenderContext(pageEvent: PageEvent<Reflection>) { | ||
return new CustomMarkdownTheme(pageEvent, this.application.options); | ||
} | ||
} | ||
|
||
class CustomMarkdownTheme extends MarkdownThemeRenderContext { | ||
override header = () => { | ||
return "CUSTOM HEADER HERE"; | ||
}; | ||
|
||
override footer = () => { | ||
return "CUSTOM FOOTER HERE"; | ||
}; | ||
} | ||
``` | ||
|
||
To theme can then be added to the TypeDoc config as follows: | ||
|
||
```json filename="typedoc.json" | ||
{ | ||
"plugin": ["typedoc-plugin-markdown", "./dist/custom-plugin"], | ||
"theme": "custom-markdown-theme" | ||
} | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
{ | ||
"api": "API" | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
# API | ||
|
||
Please note you have a theme context. |
Oops, something went wrong.