platyPS
platyPS copied to clipboard
Write PowerShell External Help in Markdown
Update-MarkdownHelp does not update Steps to reproduce ------------------ Create a function in a Module, do NOT describe a parameter. Import the module, run `New-MarkdownHelp -Module` The description for uncommented Parameter...
I am trying to update the help for the CimCmdlets module. The parameter `-CimSession` has a list of parameter sets in the existing content. That list is missing one parameter...
I wouldn't necessarily call this a bug, but what is the expected Merge-MarkdownHelp result if the Type value of the same parameter in the same cmdlet changes from one version...
Steps to reproduce ------------------ 1. Take existing markdown files not created by platyPS for Exchange 2010, 2013, and 2016 (see attached). 2. Run Merge-MarkdownHelp -ExplicitApplicableIfAll -Path "InPath1","InPath2","InPath3" -OutputPath "OutPath" Expected...
Steps to reproduce ------------------ 1. Have your .md with a section like ```## Related Links - [Link1](link1.md) - [Link2](link2.md) ``` 2. Run the New-ExternalHelp cmdlet to generate the offline documentation...
(and I think they *should* be allowed) Steps to reproduce ------------------ In a `## DESCRIPTION` section, add a fenced code block (I *think* that's what they're called: when you have...
In TransformBase.cs the following snippet does not include ExternalScriptInfo to check for CmdletBinding. It should be included. ``` if ((cmdletInfo is FunctionInfo funcInfo && funcInfo.CmdletBinding) || cmdletInfo is CmdletInfo) ```...
This is an annoying problem that I find in several files. My markdown file will show a syntax like this: ```yaml Install-PowerShell [[-Path] ] [-EnableRemoting] [-EnableContextMenu] [-EnableRunContext] [[-Mode] ] [-WhatIf]...
Merge-MarkdownHelp is used by the Office teams for their PowerShell content. We need to understand the requirements for this before commit to a new implementation.
Planned cmdlet updates for V2 milestone based on specification https://github.com/PowerShell/platyPS/blob/master/specs/platyps_2.0_update.md