-
Notifications
You must be signed in to change notification settings - Fork 172
/
public-api.ts
30 lines (30 loc) · 1.19 KB
/
public-api.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
/**
* The public API of the typedoc-plugin-markdown exposes some classes and types that can be used to customize the output of the plugin. Please note this only covers the API relevant to this plugin and not cover the entire [TypeDoc API](https://typedoc.org/api/).
*
* The APIs are typically consumed by writing [local plugins](/docs/customizing-output#local-plugins).
*
* @categoryDescription Application
*
* The Application class is the main entry point for a TypeDoc application and provides the mechanism to listen to hooks, events and define new themes.
*
* @categoryDescription Options
*
* Types that are used to define the plugin options.
*
* @categoryDescription Theme
*
* Classes and types that are used to define the Markdown theme and create custom themes.
*
* @module
*/
export { MarkdownApplication, MarkdownRenderer } from '@plugin/app/application';
export { MarkdownPageEvent, MarkdownRendererEvent } from '@plugin/app/events';
export { MarkdownRendererHooks } from '@plugin/app/renderer';
export { PluginOptions, TextContentMappings } from '@plugin/options';
export {
MarkdownTheme,
MarkdownThemeContext,
NavigationItem,
PackageMetaData,
UrlMapping,
} from '@plugin/theme';