Skip to main content

Function: h()

h(level, title, ...contents): string

Function to create an arbitrary heading

Parameters

level: number

The level of the heading. Must be between 1 and 6.

title: string

The title of the heading.

• ...contents: string[]

The contents of the section.

Returns

string

The markdown heading, with the contents section below it.

Example

console.log(h(1, 'Heading 1', 'This is the contents of the section.'));
// Prints:
//
// # Heading 1
//
// This is the contents of the section.

Defined in

lib/markdown.ts:25