platyPS
platyPS copied to clipboard
Add Aliases to the Cmdlet Reference MD
When Cmdlet MD files are created, the Aliases should be picked up from either the MAML or from
Get-Alias -Definition CmdletName
This information should be added to the Markdown in a manner similar to the below. It will also need to flow through into the Generated MAML. This needs to be address in both the generation of MAML and MD, and the update of MD.
Update-MarkdownHelp
Aliases: Foo, Bar, Baz
SYNOPSIS
Update platyPS markdown help files in place.
SYNTAX
Update-MarkdownHelp [-Path] <String[]> [[-Encoding] <Encoding>] [[-LogPath] <String>] [-LogAppend]
[<CommonParameters>]
future note from an offhand conversation in the hallway that applied.... could use this to find aliases in system:
(get-alias -Definition Get-Computer -ErrorAction SilentlyContinue).count
Items with multiple aliases will return a count of the total number of aliases available. While this command would typically return an error, with the ErrorAction preference set, it only returns 0 if none are found.
Is something that is still planned?
Microsoft.PowerShell.PlatyPS v1 adds schema and support for aliases.