DscResource.DocGenerator
0.13.0-preview0004
Functionality to help generate documentation for modules.
Minimum PowerShell version
5.0
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.13.0-preview0004] - 2024-11-17
### Removed
- Removed `build.psd1` as it is no longer required to build the project.
- Removed ClassAst functions
- `Get-ClassResourceProperty`
- `Get-ClassAst`
- `Get-ClassResourceAst`
### Added
- Added a devcontainer for development.
- Added private function `ConvertTo-WikiSidebarLinkName` that converts a
name to a format suitable for use as a Wiki sidebar link.
- New tasks:
- `Prepare_Markdown_FileNames_For_GitHub_Publish` - This task will prepare
the markdown file names for publishing to the GitHub Wiki by replacing
hyphens with spaces and converting Unicode hyphens to standard hyphens.
It can be controlled by parameter `ReplaceHyphen` in the task, which
defaults to `$true`.
- `Clean_WikiContent_For_GitHub_Publish` - This task will remove the top
level header from any markdown file where the top level header equals the
filename. The task will convert standard hyphens to spaces and Unicode
hyphens to standard hyphens before comparison. The task can be controlled
by parameter `RemoveTopLevelHeader` in the task, which defaults to `$true`.
- Added Helper functions as part of [#163] (https://github.com/dsccommunity/DscResource.DocGenerator/pull/163).
- `Get-ClassPropertyCustomAttribute`
- `Get-DscResourceAttributeProperty`
- `Get-DscPropertyType`
- `Test-ClassPropertyDscAttributeArgument`
### Changed
- `New-GitHubWikiSidebar`
- Replaces ASCII hyphens for the Wiki sidebar.
- Replaces Unicode hyphens with standard hyphens for the Wiki sidebar.
- Task `Generate_Wiki_Content`
- Now calls `Prepare_Markdown_FileNames_For_GitHub_Publish` after the
markdown files and external help file for command help has been generated.
- Now calls `Clean_WikiContent_For_GitHub_Publish` as the last step to
remove the top level header from any markdown file where the top level
header equals the filename.
- Task `Generate_Markdown_For_Public_Commands`
- Verbose output of the markdown files that was created.
- Task `Generate_Markdown_For_DSC_Resources`
- Outputs a warning message if the old configuration key is used in the
build configuration but keeps using the old configuration key.
- `New-DscClassResourcePage`
- Remove using Ast to generate documentation. Fixes [#116](https://github.com/dsccommunity/DscResource.DocGenerator/issues/116).
- Order properties correctly fixes [#126](https://github.com/dsccommunity/DscResource.DocGenerator/issues/126).
### Fixed
- Fix Dockerfile to include GitVersion alias for PowerShell Extension profile script.
- Fix `.vscode/settings.json` file to exclude unrecognized words.
FileList
- DscResource.DocGenerator.nuspec
- tasks\Package_Wiki_Content.build.ps1
- DscResource.DocGenerator.psd1
- tasks\Generate_Wiki_Sidebar.build.ps1
- DscResource.DocGenerator.psm1
- tasks\Copy_Source_Wiki_Folder.build.ps1
- en-US\DscResource.DocGenerator-help.xml
- tasks\Generate_Wiki_Content.build.ps1
- en-US\DscResource.DocGenerator.strings.psd1
- tasks\Generate_Conceptual_Help.build.ps1
- en-US\about_DscResource.DocGenerator.help.txt
- tasks\Clean_Markdown_Metadata.build.ps1
- tasks\Publish_GitHub_Wiki_Content.build.ps1
- tasks\Generate_Markdown_For_Public_Commands.build.ps1
- tasks\Generate_Markdown_For_DSC_Resources.build.ps1
- Modules\DscResource.Common\0.19.0\DscResource.Common.psd1
- tasks\Create_Wiki_Output_Folder.build.ps1
- Modules\DscResource.Common\0.19.0\DscResource.Common.psm1
- tasks\Prepare_Markdown_Filenames_For_GitHub_Publish.build.ps1
- Modules\DscResource.Common\0.19.0\en-US\about_DscResource.Common.help.txt
- tasks\Clean_Markdown_Of_Public_Commands.build.ps1
- Modules\DscResource.Common\0.19.0\en-US\DscResource.Common-help.xml
- tasks\Generate_External_Help_File_For_Public_Commands.build.ps1
- Modules\DscResource.Common\0.19.0\en-US\DscResource.Common.strings.psd1
- tasks\Clean_WikiContent_For_GitHub_Publish.build.ps1
Version History
| Version | Downloads | Last updated |
|---|---|---|
| 0.13.0-previ... (current version) | 46 | 11/17/2024 |
| 0.13.0-previ... | 33 | 10/26/2024 |
| 0.13.0-previ... | 4 | 10/23/2024 |
| 0.13.0-previ... | 46 | 10/20/2024 |
| 0.12.5 | 1,883 | 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 | 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 | 7,008 | 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 |