Split-MarkdownTopic

Parses a Markdown-formatted module help topic, e.g. about_Module.

Syntax

Split-MarkdownTopic [-ConfigFileRoot] <Object> [-TopicInfo] <Object> [<CommonParameters>]

Description

A Markdown-formatted help topic should contain four sections, Topic, Short Description, Long Description, and See Also. These should all be formatted as level-1 headings. For example:

# Topic

about_Silk

# Short Description

Silk is a PowerShell module used to convert another module's help system into an HTML website.

# Long Description

MOre details here.  Yadda, yadda, yadda.

# See Also

about_Silk_AdditionalTopic

Parameters

Name Type Description Required? Pipeline Input Default Value
ConfigFileRoot Object

The root where the config file was found.

true false
TopicInfo Object

An object containing information about the topic to parse.

true true (ByValue)