{"id":20156178,"url":"https://github.com/dsccommunity/dscresource.docgenerator","last_synced_at":"2025-04-09T22:21:42.759Z","repository":{"id":40401086,"uuid":"225105749","full_name":"dsccommunity/DscResource.DocGenerator","owner":"dsccommunity","description":"Module for generation of DSC resource documentation","archived":false,"fork":false,"pushed_at":"2024-10-20T15:24:36.000Z","size":933,"stargazers_count":9,"open_issues_count":14,"forks_count":10,"subscribers_count":5,"default_branch":"main","last_synced_at":"2024-10-20T17:10:35.667Z","etag":null,"topics":["documentation","dsc","dsc-community","dsc-resources","powershell","powershell-module"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dsccommunity.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-12-01T04:20:57.000Z","updated_at":"2024-10-20T15:17:13.000Z","dependencies_parsed_at":"2024-08-13T21:33:42.545Z","dependency_job_id":"b432a026-5a82-4a96-bfd0-a76f390a764f","html_url":"https://github.com/dsccommunity/DscResource.DocGenerator","commit_stats":null,"previous_names":[],"tags_count":97,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FDscResource.DocGenerator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FDscResource.DocGenerator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FDscResource.DocGenerator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dsccommunity%2FDscResource.DocGenerator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dsccommunity","download_url":"https://codeload.github.com/dsccommunity/DscResource.DocGenerator/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248120243,"owners_count":21050915,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","dsc","dsc-community","dsc-resources","powershell","powershell-module"],"created_at":"2024-11-13T23:37:53.588Z","updated_at":"2025-04-09T22:21:42.737Z","avatar_url":"https://github.com/dsccommunity.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DscResource.DocGenerator\r\n\r\nFunctionality to help generate documentation for modules.\r\n\r\n[![Build Status](https://dev.azure.com/dsccommunity/DscResource.DocGenerator/_apis/build/status/dsccommunity.DscResource.DocGenerator?branchName=main)](https://dev.azure.com/dsccommunity/DscResource.DocGenerator/_build/latest?definitionId=19\u0026branchName=main)\r\n![Azure DevOps coverage (branch)](https://img.shields.io/azure-devops/coverage/dsccommunity/DscResource.DocGenerator/19/main)\r\n[![codecov](https://codecov.io/gh/dsccommunity/DscResource.DocGenerator/branch/main/graph/badge.svg)](https://codecov.io/gh/dsccommunity/DscResource.DocGenerator)\r\n[![Azure DevOps tests](https://img.shields.io/azure-devops/tests/dsccommunity/DscResource.DocGenerator/19/main)](https://dsccommunity.visualstudio.com/DscResource.DocGenerator/_test/analytics?definitionId=19\u0026contextType=build)\r\n[![PowerShell Gallery (with prereleases)](https://img.shields.io/powershellgallery/vpre/DscResource.DocGenerator?label=DscResource.DocGenerator%20Preview)](https://www.powershellgallery.com/packages/DscResource.DocGenerator/)\r\n[![PowerShell Gallery](https://img.shields.io/powershellgallery/v/DscResource.DocGenerator?label=DscResource.DocGenerator)](https://www.powershellgallery.com/packages/DscResource.DocGenerator/)\r\n\r\n## Code of Conduct\r\n\r\nThis project has adopted this [Code of Conduct](CODE_OF_CONDUCT.md).\r\n\r\n## Releases\r\n\r\nFor each merge to the branch `main` a preview release will be\r\ndeployed to [PowerShell Gallery](https://www.powershellgallery.com/).\r\nPeriodically a release version tag will be pushed which will deploy a\r\nfull release to [PowerShell Gallery](https://www.powershellgallery.com/).\r\n\r\n## Contributing\r\n\r\nPlease check out common DSC Community [contributing guidelines](https://dsccommunity.org/guidelines/contributing).\r\nThis repository align to the [DSC Community Style Guidelines](https://dsccommunity.org/styleguidelines).\r\n\r\n## Change log\r\n\r\nA full list of changes in each version can be found in the [change log](CHANGELOG.md).\r\n\r\n## Known Issues\r\n\r\n### Composite Resources and Linux\r\n\r\nThe commands and tasks that generate documentation for composite resources require\r\nthe `configuration` statement that is provided by DSC. DSC is not installed\r\non Linux by default, so these commands will fail on Linux if the DSC\r\nresource module contains any composite resources. To enable these commands to work\r\non Linux, please install [PowerShell DSC for Linux](https://github.com/Microsoft/PowerShell-DSC-for-Linux).\r\n\r\n## Commands\r\n\r\nRefer to the [repository Wiki](https://github.com/dsccommunity/DscResource.DocGenerator/wiki)\r\nfor more information about the commands.\r\n\r\nThe information is also available in the comment-based help by running:\r\n\r\n```powershell\r\nGet-Help -Name \u003cCmdletName\u003e -Detailed\r\n```\r\n\r\n## Tasks\r\n\r\nThese are `Invoke-Build` tasks. The build tasks are primarily meant to be\r\nrun by the project [Sampler's](https://github.com/gaelcolas/Sampler)\r\n`build.ps1` which wraps `Invoke-Build` and has the configuration file\r\n(`build.yaml`) to control its behavior.\r\n\r\nTo make the tasks available for the command `Invoke-Build` in a repository\r\nthat is based on the [Sampler](https://github.com/gaelcolas/Sampler) project,\r\nadd this module to the file `RequiredModules.psd1` and then in the file\r\n`build.yaml` add the following:\r\n\r\n```yaml\r\nModuleBuildTasks:\r\n  DscResource.DocGenerator:\r\n    - 'Task.*'\r\n```\r\n\r\n### `Clean_Markdown_Of_Public_Commands`\r\n\r\nThis build task runs the command `Edit-CommandDocumentation` on each markdown\r\nfile that was generated by the task `Generate_Markdown_For_Public_Commands`.\r\n\r\nSee the command `Edit-CommandDocumentation` for more information.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n\u003e[!NOTE] This task is meant to be run after the tasks\r\n\u003e`Generate_Markdown_For_Public_Commands` and `Generate_Wiki_Content`, but\r\n\u003ebefore the task `Clean_Markdown_Metadata`.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Wiki_Content\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Clean_Markdown_Of_Public_Commands\r\n\r\n  publish:\r\n    - Publish_release_to_GitHub\r\n    - publish_module_to_gallery\r\n    - Publish_GitHub_Wiki_Content\r\n```\r\n\r\n### `Clean_Markdown_Metadata`\r\n\r\nThis build task runs the command `Remove-MarkdownMetadataBlock` on each markdown\r\nfile that is present in the folder provided by the parameter `DocOutputFolder`\r\n(defaults to _./output/WikiContent_).\r\n\r\nSee the command `Remove-MarkdownMetadataBlock` for more information.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n\u003e[!NOTE] This task is meant to be run after all tasks that generate of modifies\r\n\u003emarkdown.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Wiki_Content\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Clean_Markdown_Metadata\r\n\r\n  publish:\r\n    - Publish_release_to_GitHub\r\n    - publish_module_to_gallery\r\n    - Publish_GitHub_Wiki_Content\r\n```\r\n\r\n### `Clean_WikiContent_For_GitHub_Publish`\r\n\r\n\u003e[!IMPORTANT]\r\n\u003eThis task does not work in Windows PowerShell due to it not supporting\r\n\u003eunicode in filenames.\r\n\r\nThis build task will clean the markdown files for publishing to the GitHub Wiki.\r\nIt can be controlled by parameter `RemoveTopLevelHeader` in the task, which\r\ndefaults to `$true`.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Clean_WikiContent_For_GitHub_Publish\r\n```\r\n\r\n### `Copy_Source_Wiki_Folder`\r\n\r\nThis build task will copy the content of the wiki source folder if it exist\r\n(the parameter `WikiSourceFolderName` defaults to `WikiSource`). The wiki\r\nsource folder should be located under the source folder, e.g. `source/WikiSource`.\r\nThe wiki source folder is meant to contain additional documentation that\r\nwill be added to folder `WikiOutput` during build, and then published to\r\nthe wiki during the deploy stage (if either the command `Publish-WikiContent`\r\nor the task `Publish_GitHub_Wiki_Content` is used).\r\n\r\nif the `Home.md` is present in the folder specified in `WikiSourceFolderName`\r\nit will be copied to `WikiOutput` and all module version placeholders (`#.#.#`)\r\nof the content the file will be replaced with the built module version.\r\n\r\n### `Create_Wiki_Output_Folder`\r\n\r\nThis build task creates the folder `output/WikiContent`.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  docs:\r\n    - Create_Wiki_Output_Folder\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Clean_Markdown_Of_Public_Commands\r\n    - Copy_Source_Wiki_Folder\r\n    - Generate_Wiki_Sidebar\r\n    - Clean_Markdown_Metadata\r\n    - Package_Wiki_Content\r\n```\r\n\r\n### `Generate_Conceptual_Help`\r\n\r\nThis build task runs the command `New-DscResourcePowerShellHelp`.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Conceptual_Help\r\n```\r\n\r\nIf the schema mof property descriptions contain markdown code then it is\r\npossible to configure regular expressions to remove the markdown code.\r\nThe regular expressions must be written so that capture group 0 returns\r\nthe full match and the capture group 1 returns the text that should be kept.\r\nFor example the regular expression `` \\`(.+?)\\` `` will find `` `$true` ``\r\nwhich will be replaced to `$true` since that is what will be returned by\r\ncapture group 1.\r\n\r\nBelow is some example regular expressions for the most common markdown code.\r\n\r\n\u003e**NOTE:** Each regular expression must be able to find multiple matches\r\n\u003eon the same row.\r\n\r\n```yaml\r\nDscResource.DocGenerator:\r\n  Generate_Conceptual_Help:\r\n    MarkdownCodeRegularExpression:\r\n      - '\\`(.+?)\\`' # Match inline code-block\r\n      - '\\\\(\\\\)' # Match escaped backslash\r\n      - '\\[[^\\[]+\\]\\((.+?)\\)' # Match markdown URL\r\n      - '_(.+?)_' # Match Italic (underscore)\r\n      - '\\*\\*(.+?)\\*\\*' # Match bold\r\n      - '\\*(.+?)\\*' # Match Italic (asterisk)\r\n```\r\n\r\n\u003e**NOTE:** If the task is used in a module that is using the project [Sampler's](https://github.com/gaelcolas/Sampler)\r\n\u003e`build.ps1` then version 0.102.1 of [Sampler](https://github.com/gaelcolas/Sampler)\r\n\u003eis required.\r\n\r\n### `Generate_External_Help_File_For_Public_Commands`\r\n\r\nThis build task runs the command `New-ExternalHelp` (PlatyPS command) that\r\nwill generate an external help file for the module based on the generated\r\nmarkdown. See the command `New-ExternalHelp` for more information.\r\n\r\nIt is possible to pass `HelpCultureInfo` (default is `en-US`), it can be\r\nset either in parent scope, as an environment variable, or if passed as\r\na parameter to the build task.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n\u003e[!NOTE] This task is meant to be run after the tasks\r\n\u003e`Generate_Markdown_For_Public_Commands`, and it is meant that the task\r\n\u003e`Clean_Markdown_Of_Public_Commands` is ran after.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Wiki_Content\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Generate_External_Help_File_For_Public_Commands\r\n    - Clean_Markdown_Of_Public_Commands\r\n\r\n  publish:\r\n    - Publish_release_to_GitHub\r\n    - publish_module_to_gallery\r\n    - Publish_GitHub_Wiki_Content\r\n```\r\n\r\n### `Generate_External_Help_File_For_Public_Commands`\r\n\r\nThis build task runs the command `New-ExternalHelp` (PlatyPS command) that\r\nwill generate an external help file for the module based on the generated\r\nmarkdown. See the command `New-ExternalHelp` for more information.\r\n\r\nIt is possible to pass `HelpCultureInfo` (default is `en-US`), it can be\r\nset either in parent scope, as an environment variable, or if passed as\r\na parameter to the build task.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n\u003e[!NOTE] This task is meant to be run after the tasks\r\n\u003e`Generate_Markdown_For_Public_Commands`, and it is meant that the task\r\n\u003e`Clean_Markdown_Of_Public_Commands` is ran after.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Wiki_Content\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Generate_External_Help_File_For_Public_Commands\r\n    - Clean_Markdown_Of_Public_Commands\r\n\r\n  publish:\r\n    - Publish_release_to_GitHub\r\n    - publish_module_to_gallery\r\n    - Publish_GitHub_Wiki_Content\r\n```\r\n\r\n### `Generate_Markdown_For_Public_Commands`\r\n\r\nThis build task runs the command `New-MarkdownHelp` (PlatyPS command) that\r\nwill generate markdown for the module's public commands. See the command\r\n`New-MarkdownHelp` for more information.\r\n\r\nIt is possible to pass:\r\n\r\n- `HelpCultureInfo` (default is `en-US`)\r\n- `DependentTypePath` (default is an empty array)\r\n- `DependentModule` (default is an empty array)\r\n- `WithModulePage` (default is `$false`)\r\n- `AlphabeticParamOrder` (default is `$true`)\r\n- `ExcludeDontShow` (default is `$true`)\r\n\r\nThey can be set either in parent scope, as an environment variable, or if\r\npassed as a parameter to the build task.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Wiki_Content\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Clean_Markdown_Of_Public_Commands\r\n\r\n  publish:\r\n    - Publish_release_to_GitHub\r\n    - publish_module_to_gallery\r\n    - Publish_GitHub_Wiki_Content\r\n```\r\n\r\n### `Generate_Wiki_Content`\r\n\r\nThis is a metatask that runs the task (in order):\r\n\r\n- `Create_Wiki_Output_Folder`\r\n- `Generate_Markdown_For_Public_Commands`\r\n- `Generate_External_Help_File_For_Public_Commands`\r\n- `Prepare_Markdown_FileNames_For_GitHub_Publish`\r\n- `Clean_Markdown_Of_Public_Commands`\r\n- `Generate_Markdown_For_DSC_Resources`\r\n- `Copy_Source_Wiki_Folder`\r\n- `Clean_WikiContent_For_GitHub_Publish`\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Wiki_Content\r\n```\r\n\r\n### `Generate_Markdown_For_DSC_Resources`\r\n\r\nThis build task runs the command `New-DscResourceWikiPage` to build\r\ndocumentation for DSC resources.\r\n\r\nSee the command `New-DscResourceWikiPage` for more information.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  docs:\r\n    - Generate_Conceptual_Help\r\n    - Create_Wiki_Output_Folder\r\n    - Generate_Markdown_For_DSC_Resources\r\n    - Copy_Source_Wiki_Folder\r\n    - Package_Wiki_Content\r\n```\r\n\r\n### `Generate_Wiki_Sidebar`\r\n\r\nThis build task runs the command `New-GitHubWikiSidebar` (PlatyPS command) that\r\nwill generate markdown for the module's public commands. See the command\r\n`New-GitHubWikiSidebar` for more information.\r\n\r\nIt is possible to pass:\r\n\r\n- `DocOutputFolder` (default is `./output/WikiContent`)\r\n- `DebugTask` (default is `$true`)\r\n\r\nThey can be set either in parent scope, as an environment variable, or if\r\npassed as a parameter to the build task.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n\u003e[!NOTE] This task is meant to be run after all the needed tasks that generate\r\n\u003e markdown documentation. It must be run before `Clean_Markdown_Metadata`.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Wiki_Content\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Clean_Markdown_Of_Public_Commands\r\n    - Generate_Wiki_Sidebar\r\n    - Clean_Markdown_Metadata\r\n\r\n  publish:\r\n    - Publish_release_to_GitHub\r\n    - publish_module_to_gallery\r\n    - Publish_GitHub_Wiki_Content\r\n```\r\n\r\n### `Prepare_Markdown_FileNames_For_GitHub_Publish`\r\n\r\n\u003e[!IMPORTANT]\r\n\u003eThis task does not work in Windows PowerShell due to it not supporting\r\n\u003eunicode in filenames.\r\n\r\nThis build task will replace the hyphen in the markdown filenames with the\r\nunicode non-breaking hyphen. It can be controlled by parameter\r\n`ReplaceHyphen` in the task, which defaults to `$true`.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Markdown_For_Public_Commands\r\n    - Prepare_Markdown_FileNames_For_GitHub_Publish\r\n```\r\n\r\n### `Publish_GitHub_Wiki_Content`\r\n\r\nThis build task runs the command `Publish-WikiContent`. The task will only\r\nrun if the variable `$GitHubToken` is set either in parent scope, as an\r\nenvironment variable, or if passed to the build task.\r\n\r\nSee the command `Publish-WikiContent` for more information.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n\u003e**NOTE:** This task is meant to be run after the task `Generate_Wiki_Content`\r\n\u003ethat is normally run in the build phase. But this task can be used to upload\r\n\u003eany content to a Wiki.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n    - Generate_Wiki_Content\r\n\r\n  publish:\r\n    - Publish_release_to_GitHub\r\n    - publish_module_to_gallery\r\n    - Publish_GitHub_Wiki_Content\r\n```\r\n\r\nIt is also possible to enable debug output information for the task when\r\nit is run by adding this to the build configuration:\r\n\r\n```yaml\r\nDscResource.DocGenerator:\r\n  Publish_GitHub_Wiki_Content:\r\n    Debug: true\r\n```\r\n\r\n### `Package_Wiki_Content`\r\n\r\nThis build task runs the command `Compress-Archive`.\r\n\r\nBelow is an example how the build task can be used when a repository is\r\nbased on the [Sampler](https://github.com/gaelcolas/Sampler) project.\r\n\r\n\u003e**NOTE:** This task is meant to be run after the task `Generate_Wiki_Content`\r\n\u003ethat is normally run in the docs phase. But this task can be used to upload\r\n\u003eany content to a Wiki.\r\n\r\n```yaml\r\nBuildWorkflow:\r\n  '.':\r\n    - build\r\n\r\n  build:\r\n    - Clean\r\n    - Build_Module_ModuleBuilder\r\n    - Build_NestedModules_ModuleBuilder\r\n    - Create_changelog_release_output\r\n\r\n  docs:\r\n    - Generate_Conceptual_Help\r\n    - Generate_Wiki_Content\r\n    - Package_Wiki_Content\r\n\r\n```\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsccommunity%2Fdscresource.docgenerator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdsccommunity%2Fdscresource.docgenerator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdsccommunity%2Fdscresource.docgenerator/lists"}