Get-PSDocumentHeader
SYNOPSIS
Get the Yaml header from a PSDocs generated markdown file.
SYNTAX
Get-PSDocumentHeader [[-Path] <String>] [<CommonParameters>]
DESCRIPTION
Get the Yaml header from a PSDocs generated markdown file.
EXAMPLES
Example 1
PS C:\> Get-PSDocumentHeader -Path '.\build\Default';
Get the Yaml header for all markdown files in the Default directory.
Example 2
PS C:\> Get-PSDocumentHeader -Path '.\build\Default\Server1.md';
Get the Yaml header for a specific file Server1.md.
Example 3
PS C:\> Get-PSDocumentHeader;
Get the Yaml header for all markdown files in the current working directory.
PARAMETERS
-Path
The path to a specific markdown file or a parent directory containing one or more markdown files. A trailing slash is not required.
If a path is not specified the current working path will be used.
Type: System.String
Parameter Sets: (All)
Aliases: FullName
Required: False
Position: 0
Default value: $PWD
Accept pipeline input: True (ByPropertyName)
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.