Interface H1Entry

A markdown entry for generating h1 elements.

Hierarchy

Properties

Properties

append?: string

Option which will arbitrarily append a string immediately below the h1, ignoring block-level settings.

The h1 contents and identifying property for the renderer.

id?: string

Option which will append a markdown heading ID. E.g., given the ID 'my-id' and the header 'Header Example', # Header Example {#my-id}

underline?: boolean

Option which will use '=' underlining rather than a '#' prefix.

Generated using TypeDoc