PowerShell Module "KNSModulesDocsGenerator"
Version 1.0.0
This module generate automatically documentation from Powershell Modules in Markdown (md Files) and Confluence Markup syntax
Format-ConfluenceMarkup [-ContentObject] <Object> [[-FileName] <Object>] [-NoTableOfContent] [<CommonParameters>]
Name |
Alias |
Description |
Required? |
Pipeline Input |
Default Value |
ContentObject |
None |
Content Generated from Get-ModuleDocumentation |
true |
true (ByValue) |
|
FileName |
None |
If specified, the content will be exported to this file |
false |
false |
|
NoTableOfContent |
None |
|
false |
false |
|
Format-Markdown [-ContentObject] <Object> [[-FileName] <Object>] [<CommonParameters>]
Name |
Alias |
Description |
Required? |
Pipeline Input |
Default Value |
ContentObject |
None |
Content Generated from Get-ModuleDocumentation |
true |
true (ByValue) |
|
FileName |
None |
If specified, the content will be exported to this file |
false |
false |
|
Get-ModuleDocumentation [-ModuleName] <Object> [<CommonParameters>]
Name |
Alias |
Description |
Required? |
Pipeline Input |
Default Value |
ModuleName |
None |
The module name to be documented |
true |
false |
|
Update-ConfluenceDoc [-Content] <Object> [-ConfluenceURL] <string> [-ConfluencePageID] <string> [-Credential] <pscredential> [<CommonParameters>]
Name |
Alias |
Description |
Required? |
Pipeline Input |
Default Value |
ConfluencePageID |
PageID, ID |
|
true |
false |
|
ConfluenceURL |
URL |
|
true |
false |
|
Content |
None |
|
true |
true (ByValue) |
|
Credential |
None |
|
true |
false |
|