| 1 | import { ProjectReflection, Reflection } from 'typedoc';
|
| 2 | /**
|
| 3 | * An event emitted before and after the markdown of a page is rendered.
|
| 4 | *
|
| 5 | * @event
|
| 6 | */
|
| 7 | export declare class MarkdownPageEvent<
|
| 8 | /** @ignore **/ Model = Reflection> extends Event {
|
| 9 | /**
|
| 10 | * The {@linkcode typedoc!ProjectReflection ProjectReflection} instance the renderer is currently processing.
|
| 11 | */
|
| 12 | project: ProjectReflection;
|
| 13 | /**
|
| 14 | * The model that that is being rendered on this page.
|
| 15 | * Either a {@linkcode typedoc!DeclarationReflection DeclarationReflection} or {@linkcode typedoc!ProjectReflection ProjectReflection}.
|
| 16 | */
|
| 17 | readonly model: Model;
|
| 18 | /**
|
| 19 | * The group title of the group reflection belongs to.
|
| 20 | */
|
| 21 | group?: string;
|
| 22 | /**
|
| 23 | * The final markdown `string` content of the page.
|
| 24 | *
|
| 25 | * Should be rendered by layout templates and can be modified by plugins.
|
| 26 | */
|
| 27 | contents?: string;
|
| 28 | /**
|
| 29 | * The url `string` of the page.
|
| 30 | */
|
| 31 | url: string;
|
| 32 | /**
|
| 33 | * The complete `string` filename where the file will be written..
|
| 34 | */
|
| 35 | filename: string;
|
| 36 | /**
|
| 37 | * The frontmatter of this page represented as a key value object. This property can be utilised by other plugins.
|
| 38 | */
|
| 39 | frontmatter?: Record<string, any>;
|
| 40 | /** @hidden */
|
| 41 | pageHeadings: any;
|
| 42 | /** @hidden */
|
| 43 | pageSections: any;
|
| 44 | /** @hidden */
|
| 45 | startNewSection: any;
|
| 46 | /**
|
| 47 | * Triggered before a document will be rendered.
|
| 48 | * @event
|
| 49 | */
|
| 50 | static readonly BEGIN = "beginPage";
|
| 51 | /**
|
| 52 | * Triggered after a document has been rendered, just before it is written to disc.
|
| 53 | * @event
|
| 54 | */
|
| 55 | static readonly END = "endPage";
|
| 56 | /**
|
| 57 | * @ignore
|
| 58 | */
|
| 59 | constructor(name: string, model: Model);
|
| 60 | }
|