TOC

Full name Microsoft.VisualBasic.MIME.text.markdown.TOC Assembly Microsoft.VisualBasic.MIME.text.markdown Members 3

01 Syntax

Microsoft.VisualBasic.MIME.text.markdown.TOC

02 Methods

Name	Overloads	Summary
GenerateToc	1	Generate a nested markdown table of contents from the ATX headers (# ..
Slug	1	Make a url friendly anchor slug out of a header text.
AddToc	1	Insert a generated table of contents at the top of the markdown document.

03 Members

method GenerateToc #

GenerateToc(String, Boolean)

Generate a nested markdown table of contents from the ATX headers (# .. ######) found in the document.

Parameters

Name	Type	Description
`md`	`String`	The markdown source text.
`numbering`	`Boolean`	Reserved for future numbered list output.

Returns

A markdown list string representing the document outline.

method Slug #

Slug(String)

Make a url friendly anchor slug out of a header text.

method AddToc #

AddToc(String, Boolean, Boolean)

Insert a generated table of contents at the top of the markdown document.

Parameters

Name	Type	Description
`md`	`String`	The markdown source text.
`numbering`	`Boolean`	Reserved for future numbered list output.
`autoSave`	`Boolean`	Reserved for future file persistence.

Returns

The markdown document with a TOC block prepended.