Skip to content

New-MDHeader

SYNOPSIS

This commandlet output header in markdown syntax

SYNTAX

New-MDHeader [-Text] <String> [-Level <Int32>] [-NoNewLine] [<CommonParameters>]

DESCRIPTION

This commandlet output header in markdown syntax by adding a '# '

EXAMPLES

EXAMPLE 1

New-MDHeader -Text "This is an H1"
"This is an H1" | New-MDHeader -Text

This is an H1

EXAMPLE 2

New-MDHeader -Text "This is an H2" -Level 2
"This is an H2" | New-MDHeader -Text -Level 2

This is an H2

PARAMETERS

-Text

Any text

Type: System.String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Level

The level of header

Type: System.Int32
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: 1
Accept pipeline input: False
Accept wildcard characters: False

-NoNewLine

Controls if a new line is added at the end of the output

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

An array of lines

OUTPUTS

Each line with a '# ' in the front

NOTES

Use the -NoNewLine parameter when you don't want the next markdown content to be separated.

New-MDParagraph https://help.github.com/articles/basic-writing-and-formatting-syntax/

Back to top