platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

Write PowerShell External Help in Markdown

Results 132 platyPS issues
Sort by recently updated
recently updated
newest added

See related issue #419 and #420. Steps to reproduce ------------------ Run Update-MarkdownHelp (with logging) on the CimCmdlets markdown files. (see related issues). Expected behavior ----------------- Log file shows the following:...

Area-UpdateMarkdown

Problem 1: The Common Parameters block is overwritten when you run Update-MarkdownHelp. The default text for that block is contains a bare URL rather than a proper Markdown hyperlink. Problem...

Area-MarkdownWriter
Area-UpdateMarkdown

I think this is probably a misunderstanding on my part, so I'm not calling this a bug. Here's the function definition for which I am generating doc: ```powershell function Get-License...

Area-MarkdownWriter
Needs-Investigation

Markdownlint in VSCode complains about MD022 and MD040 mostly (MD031 as well, but that goes away with fixing MD022) As far as I can see, these might be fairly easy...

Area-MarkdownWriter

The current Pester tests use fixed strings for comparison of MAML content. But the build process does an Update-Help first. Since the help content has been changed in the past...

Area-Maintainers-Build

The build script is outdated which presents the following problems: - The script install the latest version of Pester (5.x) but the Pester tests are written for v4.x syntax. -...

Area-Maintainers-Build

As mentioned in [CONTRIBUTING.md](https://github.com/PowerShell/platyPS/blob/master/CONTRIBUTING.md), `build.ps1` cannot be launched again without closing & re-opening PowerShell if you do anything that would change `Markdown.MAML.dll`. I have a suggestion for a way around...

Area-Maintainers-Build

If you try to use build.ps1 in VSCode and you will be in a different folder then root it will error out. I've prepared a replacement for pwd with $PSScriptRoot....

Area-Maintainers-Build

Upon moving to docs.microsoft.com, we've been asked to add "powershell" to the opening code block of each example. Is it possible to do this so all new cmdlets have it...

Area-MarkdownWriter

Reference #180 Steps to reproduce ------------------ Function with help example: ```powershell .EXAMPLE PS> $session = New-TssSession -SecretServer https://alpha -Credential $ssCred PS> Disable-TssSecret -TssSession $session -Id 93 Disables secret 93 ```...

Area-Comment-Based-Help