| external help file | PSDocs-help.xml |
|---|---|
| Module Name | PSDocs |
| online version | https://github.com/Microsoft/PSDocs/blob/main/docs/commands/PSDocs/en-US/Get-PSDocumentHeader.md |
| schema | 2.0.0 |
Get the Yaml header from a PSDocs generated markdown file.
Get-PSDocumentHeader [[-Path] <String>] [<CommonParameters>]
Get the Yaml header from a PSDocs generated markdown file.
PS C:\> Get-PSDocumentHeader -Path '.\build\Default';Get the Yaml header for all markdown files in the Default directory.
PS C:\> Get-PSDocumentHeader -Path '.\build\Default\Server1.md';Get the Yaml header for a specific file Server1.md.
PS C:\> Get-PSDocumentHeader;Get the Yaml header for all markdown files in the current working directory.
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: String
Parameter Sets: (All)
Aliases: FullName
Required: False
Position: 0
Default value: $PWD
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.