Skip to main content

Function: h1()

h1(title, ...contents): string

Function to create a level 1 heading.

Parameters

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(h1('Heading 1', 'This is the contents of the section.'));
// Prints:
//
// # Heading 1
//
// This is the contents of the section.

Defined in

lib/markdown.ts:47