| 1 | import { MarkdownThemeContext } from '../theme/index.js';
|
| 2 | /**
|
| 3 | * Describes the hooks available to inject output in the markdown theme.
|
| 4 | */
|
| 5 | export interface MarkdownRendererHooks {
|
| 6 | /**
|
| 7 | * Applied at the start of the markdown output.
|
| 8 | *
|
| 9 | * @group Hooks
|
| 10 | */
|
| 11 | ['page.begin']: [MarkdownThemeContext];
|
| 12 | /**
|
| 13 | * Applied at the end of the markdown output.
|
| 14 | *
|
| 15 | * @group Hooks
|
| 16 | */
|
| 17 | ['page.end']: [MarkdownThemeContext];
|
| 18 | /**
|
| 19 | * Applied before the main markdown content is rendered.
|
| 20 | *
|
| 21 | * @group Hooks
|
| 22 | */
|
| 23 | ['content.begin']: [MarkdownThemeContext];
|
| 24 | /**
|
| 25 | * Applied at the start of the markdown output on the index page.
|
| 26 | *
|
| 27 | * @group Hooks
|
| 28 | */
|
| 29 | ['index.page.begin']: [MarkdownThemeContext];
|
| 30 | /**
|
| 31 | * Applied at the end of the markdown output on the index page.
|
| 32 | *
|
| 33 | * @group Hooks
|
| 34 | */
|
| 35 | ['index.page.end']: [MarkdownThemeContext];
|
| 36 | }
|