Skip to main content

DocHeading

Summary

Represents a section header similar to an HTML <h1> or <h2> element.

Signature

export declare class DocHeading extends DocNode 

Constructors

constructor

Constructs a new DocHeading.

Properties

kind

Modifiers: readonly Type:get kind(): string; Default: “

level

Modifiers: readonly Type:readonly level: number; Default: “

title

Modifiers: readonly Type:readonly title: string; Default: “

Methods

No methods defined.

Events

No events defined.

Remarks

Headings support levels 1-5, corresponding to markdown heading levels (# through #####). Level 1 is the largest heading, level 5 is the smallest. If no level is specified, defaults to level 1.

Examples

Example 1