Creates Markdown documentations from PowerShell modules and scripts.
Z:\Raidserver_Daten\SIM\PSScripts\docgenerator.ps1 [-SourceScriptFolder] <String> [-DocumentationOutputFolder] <String> [[-DocumentationIndex] <String>] [<CommonParameters>]Z:\Raidserver_Daten\SIM\PSScripts\docgenerator.ps1 [-SourceModul] <String> [-DocumentationOutputFolder] <String> [[-DocumentationIndex] <String>] [<CommonParameters>]Generates a Markdown (.md) documentation for each PowerShell script (.ps1) in a folder or each Cmdlet in a Module, which has the necessary headers required by Get-Help. Also generates an index document which lists (and links to) all generated files. Each file name can be preceded by a prefix so that they are listed together when viewing the Wiki documents.
.\docgenerator.ps1 -SourceScriptFolder 'C:\temp\project\scripts' -DocumentationOutputFolder 'C:\temp\project\docs' -DocumentationIndexPath 'README.md'.\docgenerator.ps1 -SourceModul AzureAD -DocumentationOutputFolder 'C:\temp\project\docs' -DocumentationIndexPath 'README.md'rserser
Source folder where the scripts are located
| Type: | String |
| Required: | true |
| ParameterValue: | String |
| Position: | 1 |
| PipelineInput: | false |
Source module from which the documentation are generated
| Type: | String |
| Required: | true |
| ParameterValue: | String |
| Position: | 1 |
| PipelineInput: | false |
Output folder where the documentation will be created
| Type: | String |
| Required: | true |
| ParameterValue: | String |
| Position: | 2 |
| PipelineInput: | false |
| Type: | String |
| Required: | false |
| DefaultValue: | index.md |
| ParameterValue: | String |
| Position: | 3 |
| PipelineInput: | false |