platyPS
platyPS copied to clipboard
PowerShell
Write PowerShell External Help in Markdown
Steps to reproduce ------------------ Create a script with a function and a `.EXAMPLE` comment. Run `New-MarkdownHelp` Expected behavior ----------------- A generated markdown file with ``` ## EXAMPLES ### EXAMPLE 1...
Scenarios: - Verify that markdown is compliant with schema - Verify / report that all text fields are filled (i.e. NOTES, description placeholders) Scenarios to consider: - Verify markdown metadata...
If you rename one of cmdlets, current behavior is to error out in `Update-HelpMarkdown`, because file now doesn't represent any cmdlet help. We should find a better way to handle...
See https://windowsserver.uservoice.com/forums/301869-powershell/suggestions/16304866-custom-cmdlet-help-is-broken-in-5-0 and https://windowsserver.uservoice.com/forums/301869-powershell/suggestions/15487152-help-for-documentencryptioncert-dynamic-parameter
This is a long term issue, but we have discussed creating a solution that could handle provider topics.
When Cmdlet MD files are created, the Aliases should be picked up from either the MAML or from ``` PowerShell Get-Alias -Definition CmdletName ``` This information should be added to...
My project has several hundred cmdlets. I'd like to integrate platyPS into our build workflow to automatically generate stub documentation when there's changes, but with so many cmdlets, it adds...
It's nice(at least for development) to have a one-liner to preview help engine output directly from markdown. Please, up-vote, if you want this feature. ``` powershell > Show-HelpPreview -MarkdownFile .\docs\Show-HelpPreview.md...
Because many of the commands in this module are changing state, shouldn't they support -WhatIf? Personally, I find this very important when creating external help to make sure I haven't...
## Steps to reproduce Here's the markdown: ``` ## Metadata The `metadata` section contains information about the Plaster manifest itself and requires the following data: - `name` - Manifest name....
