platyPS
platyPS copied to clipboard
PowerShell
Write PowerShell External Help in Markdown
In this simple module, I added a new function and updated a couple of parameter attributes. I made sure to import the module manually in advance. These errors should be...
In [her naming help video](https://www.youtube.com/watch?v=swrIQ2Bx-M0) @juneb is pointing out problems with cdxml help. Essentially, we should generate a better names in `GetHelpFileName` for cdxml. https://github.com/PowerShell/platyPS/blob/f24b9447afe201bc4240d8ccfda2c06bd3895b27/src/platyPS/platyPS.psm1#L1458
If you want to generate an external help cab, it seems you need to have created the module page when you run New-MarkdownHelp. But what if you didn't? There's no...
It would be nice if platyPS supported saving default configuration to a file like yaml similar to other dev ops pipeline tools instead of specifying switches on each update/merge/new command.
Would it be possible to generate markdown help, probably closer related to the about help markdown creation via a module manifest psd1 file? Or is there perhaps a best practice...
I have a project I'm using platyPS to generate documentation for existing cmdlets. My module also includes some DSC Resources. I am trying to figure out how to produce docs...
Steps to reproduce ------------------ Create a script equivalent to New-MarkdownHelp [example 1](https://github.com/PowerShell/platyPS/blob/master/docs/New-MarkdownHelp.md#example-1-create-help-from-a-command), name it `Example1.ps1` and execute it. ```PowerShell # Example1.ps1 function Command03 {param([string]$Value)} New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs" ```...
Steps to reproduce ------------------ in a c# cmdlet i define ```cs [Parameter(HelpMessage = "aaaaaaaaaaaaaaaaaaa")] public int ActivityId{ get; set; } ``` Expected behavior ----------------- I expect the module to understand...
Steps to reproduce ------------------ $path = 'C:\Users\banerjeeR\Projects\O365MigrationOps' Set-Location $path Import-Module .\O365MigrationOps.psm1 -Force New-MarkdownHelp -Module O365MigrationOps -OutputFolder $path\docs -WithModulePage -ModulePagePath $path\Index.md New-ExternalHelp .\docs -OutputPath en-US\ Open index.md and click a link...
I noticed in my latest build that Validation sets are not enumerated. Should they be? I ended up adding the enumeration myself to the `Region` parameter here: https://github.com/SpanningCloudApps/SB365-Powershell/blob/master/docs/Get-SpanningAuthentication.md Thanks
