DscResource.DocGenerator
0.12.3
Functionality to help generate documentation for modules.
Minimum PowerShell version
5.0
See the version list below for details.
Installation Options
Owners
Copyright
(c) DSC Community contributors.
Package Details
Author(s)
- DSC Community
Tags
Functions
Add-NewLine Edit-CommandDocumentation Invoke-Git New-DscResourcePowerShellHelp New-DscResourceWikiPage New-GitHubWikiSidebar Publish-WikiContent Remove-MarkdownMetadataBlock Set-WikiModuleVersion
Dependencies
This module has no dependencies.
Release Notes
## [0.12.3] - 2024-06-01
### Fixed
- `Generate_Markdown_For_Public_Commands.build`
- Now the task will not try to generate markdown if the module does not
have any publicly exported commands ([issue #135](https://github.com/dsccommunity/DscResource.DocGenerator/issues/147)).
- Now has error handling if the script that is called using the call
operator `&` fails.
`Generate_External_Help_File_For_Public_Commands`
- Now the task will not fail if there are no extern help file generated,
which is the case for modules that does not have any publicly exported
commands ([issue #135](https://github.com/dsccommunity/DscResource.DocGenerator/issues/147)).
- Now has error handling if the script that is called using the call
operator `&` fails.
FileList
- DscResource.DocGenerator.nuspec
- DscResource.DocGenerator.psd1
- tasks\Package_Wiki_Content.build.ps1
- tasks\Generate_Wiki_Sidebar.build.ps1
- DscResource.DocGenerator.psm1
- tasks\Create_Wiki_Output_Folder.build.ps1
- tasks\Generate_Conceptual_Help.build.ps1
- en-US\about_DscResource.DocGenerator.help.txt
- tasks\Clean_Markdown_Metadata.build.ps1
- en-US\DscResource.DocGenerator.strings.psd1
- tasks\Generate_Markdown_For_DSC_Resources.build.ps1
- en-US\DscResource.DocGenerator-help.xml
- tasks\Publish_GitHub_Wiki_Content.build.ps1
- Modules\DscResource.Common\0.17.1\DscResource.Common.psd1
- tasks\Copy_Source_Wiki_Folder.build.ps1
- Modules\DscResource.Common\0.17.1\DscResource.Common.psm1
- tasks\Generate_Markdown_For_Public_Commands.build.ps1
- Modules\DscResource.Common\0.17.1\en-US\about_DscResource.Common.help.txt
- tasks\Clean_Markdown_Of_Public_Commands.build.ps1
- Modules\DscResource.Common\0.17.1\en-US\DscResource.Common.strings.psd1
- tasks\Generate_External_Help_File_For_Public_Commands.build.ps1
- Modules\DscResource.Common\0.17.1\en-US\DscResource.Common-help.xml
- tasks\Generate_Wiki_Content.build.ps1
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 0.13.0-previ... | 45 | 10/20/2024 |
| 0.12.5 | 1,415 | 8/14/2024 |
| 0.12.5-previ... | 5 | 8/14/2024 |
| 0.12.5-previ... | 5 | 8/13/2024 |
| 0.12.4 | 1,787 | 6/3/2024 |
| 0.12.4-previ... | 5 | 6/3/2024 |
| 0.12.3 (current version) | 66 | 6/1/2024 |
| 0.12.3-previ... | 5 | 6/1/2024 |
| 0.12.2 | 67 | 5/31/2024 |
| 0.12.2-previ... | 5 | 5/31/2024 |
| 0.12.2-previ... | 13 | 5/29/2024 |
| 0.12.1 | 1,957 | 1/21/2024 |
| 0.12.1-previ... | 7 | 1/21/2024 |
| 0.12.0 | 18 | 1/21/2024 |
| 0.12.0-previ... | 26 | 1/19/2024 |
| 0.12.0-previ... | 49 | 1/17/2024 |
| 0.12.0-previ... | 28 | 1/14/2024 |
| 0.12.0-previ... | 42 | 12/30/2023 |
| 0.11.2 | 6,914 | 1/3/2023 |
| 0.11.2-previ... | 7 | 1/3/2023 |
| 0.11.1 | 2,469 | 8/9/2022 |
| 0.11.1-previ... | 25 | 8/9/2022 |
| 0.11.1-previ... | 24 | 8/1/2022 |
| 0.11.0 | 1,732 | 5/10/2022 |
| 0.11.0-previ... | 25 | 5/9/2022 |
| 0.10.4-previ... | 27 | 5/9/2022 |
| 0.10.4-previ... | 25 | 5/9/2022 |
| 0.10.3 | 962 | 1/26/2022 |
| 0.10.3-previ... | 25 | 1/26/2022 |
| 0.10.3-previ... | 26 | 1/26/2022 |
| 0.10.2 | 33 | 1/25/2022 |
| 0.10.2-previ... | 25 | 1/24/2022 |
| 0.10.1 | 670 | 10/19/2021 |
| 0.10.1-previ... | 25 | 10/18/2021 |
| 0.10.1-previ... | 26 | 8/7/2021 |
| 0.10.1-previ... | 26 | 8/6/2021 |
| 0.10.0 | 608 | 8/5/2021 |
| 0.10.0-previ... | 26 | 8/5/2021 |
| 0.9.1 | 364 | 7/14/2021 |
| 0.9.1-previe... | 27 | 7/13/2021 |
| 0.9.0 | 70 | 7/8/2021 |
| 0.9.0-previe... | 25 | 7/8/2021 |
| 0.9.0-previe... | 25 | 7/8/2021 |
| 0.9.0-previe... | 25 | 7/8/2021 |
| 0.9.0-previe... | 26 | 7/7/2021 |
| 0.9.0-previe... | 25 | 7/6/2021 |
| 0.9.0-previe... | 26 | 7/6/2021 |
| 0.9.0-previe... | 31 | 7/6/2021 |
| 0.9.0-previe... | 26 | 6/26/2021 |
| 0.9.0-previe... | 25 | 6/25/2021 |
| 0.9.0-previe... | 26 | 6/20/2021 |
| 0.9.0-previe... | 25 | 6/19/2021 |
| 0.9.0-previe... | 26 | 6/16/2021 |
| 0.9.0-previe... | 25 | 6/8/2021 |
| 0.8.4-previe... | 25 | 6/3/2021 |
| 0.8.3 | 1,517 | 4/10/2021 |
| 0.8.2 | 522 | 3/19/2021 |
| 0.8.1 | 160 | 3/11/2021 |
| 0.8.1-previe... | 27 | 3/11/2021 |
| 0.8.0 | 538 | 2/8/2021 |
| 0.8.0-previe... | 30 | 2/7/2021 |
| 0.7.4 | 84 | 2/2/2021 |
| 0.7.4-previe... | 28 | 2/2/2021 |
| 0.7.3 | 31 | 2/2/2021 |
| 0.7.3-previe... | 27 | 2/2/2021 |
| 0.7.3-previe... | 27 | 1/18/2021 |
| 0.7.2 | 227 | 1/17/2021 |
| 0.7.2-previe... | 28 | 1/17/2021 |
| 0.7.1 | 1,203 | 8/5/2020 |
| 0.7.1-previe... | 26 | 8/5/2020 |
| 0.7.0 | 270 | 7/8/2020 |
| 0.7.0-previe... | 26 | 7/8/2020 |
| 0.6.1 | 141 | 7/1/2020 |
| 0.6.1-previe... | 26 | 7/1/2020 |
| 0.6.1-previe... | 26 | 6/26/2020 |
| 0.6.0 | 124 | 6/22/2020 |
| 0.6.0-previe... | 27 | 6/22/2020 |
| 0.6.0-previe... | 26 | 6/20/2020 |
| 0.5.2-previe... | 27 | 6/16/2020 |
| 0.5.1 | 1,282 | 5/1/2020 |
| 0.5.1-previe... | 26 | 5/1/2020 |
| 0.5.0 | 633 | 3/28/2020 |
| 0.5.0-previe... | 28 | 3/27/2020 |
| 0.4.1-previe... | 28 | 2/26/2020 |
| 0.4.0 | 176 | 2/25/2020 |
| 0.4.0-previe... | 28 | 2/25/2020 |
| 0.4.0-previe... | 28 | 2/25/2020 |
| 0.4.0-previe... | 28 | 2/18/2020 |
| 0.3.0 | 54 | 2/11/2020 |
| 0.3.0-previe... | 28 | 2/11/2020 |
| 0.2.0 | 34 | 2/6/2020 |
| 0.1.1 | 32 | 2/2/2020 |
| 0.1.1-previe... | 32 | 2/2/2020 |