Fmg-HelpDocs
0.1.0
Full Metal Gnome: Help Docs Module
Create DocFx compatible markdown files for PowerShell modules.
This module will create markdown files that can be used with DocFx
to generate documentation for powershell modules. The module
can be altered to use other formats such as html.
The primary cmdlet to call is `Write-ModuleHelpDocs` or its alias
`Write-Help`
Full Metal Gnome: Help Docs Module
Create DocFx compatible markdown files for PowerShell modules.
This module will create markdown files that can be used with DocFx
to generate documentation for powershell modules. The module
can be altered to use other formats such as html.
The primary cmdlet to call is `Write-ModuleHelpDocs` or its alias
`Write-Help`
Installation Options
Owners
Copyright
(c) 2018 NerdyMishka. All rights reserved.
Package Details
Author(s)
- Nerdy Mishka
Tags
DocFx Documentation Help Generator Docs DevOps FMG FullMetalGnome NerdyMishka
Functions
Read-HelpExample Read-ModuleHelp Write-CmdletAlias Write-CmdletDescription Write-CmdletDoc Write-CmdletExample Write-CmdletFrontMatter Write-CmdletInput Write-CmdletLink Write-CmdletName Write-CmdletNote Write-CmdletOutput Write-CmdletParameter Write-CmdletSynopsis Write-CmdletSyntax Write-EscapedMarkdownString Write-ModuleHelpDocs
Dependencies
This module has no dependencies.
Release Notes
An early release to gather feedback
FileList
- Fmg-HelpDocs.nuspec
- Fmg-HelpDocs.psd1
- Fmg-HelpDocs.psm1
- LICENSE
- README.md
- public\Read-HelpExample.ps1
- public\Read-ModuleHelp.ps1
- public\Write-CmdletAlias.ps1
- public\Write-CmdletDescription.ps1
- public\Write-CmdletDoc.ps1
- public\Write-CmdletExample.ps1
- public\Write-CmdletFrontMatter.ps1
- public\Write-CmdletInput.ps1
- public\Write-CmdletLink.ps1
- public\Write-CmdletName.ps1
- public\Write-CmdletNote.ps1
- public\Write-CmdletOutput.ps1
- public\Write-CmdletParameter.ps1
- public\Write-CmdletSynopsis.ps1
- public\Write-CmdletSyntax.ps1
- public\Write-EscapedMarkdownString.ps1
- public\Write-ModuleHelpDocs.ps1
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 0.1.0 (current version) | 382 | 6/25/2018 |