DscResource.DocGenerator

0.10.0-preview0001

Functionality to help generate documentation for modules.

Minimum PowerShell version

5.0

This is a prerelease version of DscResource.DocGenerator.
There is a newer prerelease version of this module available.
See the version list below for details.

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name DscResource.DocGenerator -RequiredVersion 0.10.0-preview0001 -AllowPrerelease

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name DscResource.DocGenerator -Version 0.10.0-preview0001 -Prerelease

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) DSC Community contributors.

Package Details

Author(s)

  • DSC Community

Tags

DSC Modules documentation

Functions

Invoke-Git New-DscResourcePowerShellHelp New-DscResourceWikiPage Publish-WikiContent Set-WikiModuleVersion Split-ModuleVersion

Dependencies

This module has no dependencies.

Release Notes

## [0.10.0-preview0001] - 2021-08-05

### Added

- Added private functions:
 - `Out-GitResult` - Displays `Invoke-Git` returned hashtable
   via Write-Verbose and Write-Debug localized messages.
   Fixes [Issue 90](https://github.com/dsccommunity/DscResource.DocGenerator/issues/90)
 - `Hide-GitToken` - Used to redact the token from the specified
   git command so that the command can be safely outputted in logs.

### Changed

- `Publish-WikiContent`
 - Restored to original structure.
- `Invoke-Git`
 - Added `-PassThru` switch to return result hashtable and not throw
   regardless of ExitCode value when used.
 - Throws when ExitCode -ne 0 and `-PassThru` switch not used.
 - Calls `Out-GitResult` when using `-Debug` or `-Verbose`.

FileList

Version History

Version Downloads Last updated
0.13.0 7,840 2/28/2025
0.13.0-previ... 107 11/17/2024
0.13.0-previ... 35 10/26/2024
0.13.0-previ... 6 10/23/2024
0.13.0-previ... 48 10/20/2024
0.12.5 3,716 8/14/2024
0.12.5-previ... 7 8/14/2024
0.12.5-previ... 7 8/13/2024
0.12.4 1,789 6/3/2024
0.12.4-previ... 7 6/3/2024
0.12.3 68 6/1/2024
0.12.3-previ... 7 6/1/2024
0.12.2 69 5/31/2024
0.12.2-previ... 6 5/31/2024
0.12.2-previ... 15 5/29/2024
0.12.1 1,963 1/21/2024
0.12.1-previ... 9 1/21/2024
0.12.0 21 1/21/2024
0.12.0-previ... 28 1/19/2024
0.12.0-previ... 51 1/17/2024
0.12.0-previ... 30 1/14/2024
0.12.0-previ... 44 12/30/2023
0.11.2 7,239 1/3/2023
0.11.2-previ... 9 1/3/2023
0.11.1 2,471 8/9/2022
0.11.1-previ... 27 8/9/2022
0.11.1-previ... 26 8/1/2022
0.11.0 1,734 5/10/2022
0.11.0-previ... 27 5/9/2022
0.10.4-previ... 28 5/9/2022
0.10.4-previ... 27 5/9/2022
0.10.3 964 1/26/2022
0.10.3-previ... 27 1/26/2022
0.10.3-previ... 28 1/26/2022
0.10.2 35 1/25/2022
0.10.2-previ... 26 1/24/2022
0.10.1 672 10/19/2021
0.10.1-previ... 27 10/18/2021
0.10.1-previ... 28 8/7/2021
0.10.1-previ... 28 8/6/2021
0.10.0 610 8/5/2021
0.10.0-previ... (current version) 28 8/5/2021
0.9.1 366 7/14/2021
0.9.1-previe... 29 7/13/2021
0.9.0 72 7/8/2021
0.9.0-previe... 27 7/8/2021
0.9.0-previe... 27 7/8/2021
0.9.0-previe... 27 7/8/2021
0.9.0-previe... 28 7/7/2021
0.9.0-previe... 27 7/6/2021
0.9.0-previe... 28 7/6/2021
0.9.0-previe... 33 7/6/2021
0.9.0-previe... 28 6/26/2021
0.9.0-previe... 27 6/25/2021
0.9.0-previe... 28 6/20/2021
0.9.0-previe... 27 6/19/2021
0.9.0-previe... 27 6/16/2021
0.9.0-previe... 27 6/8/2021
0.8.4-previe... 27 6/3/2021
0.8.3 1,525 4/10/2021
0.8.2 524 3/19/2021
0.8.1 162 3/11/2021
0.8.1-previe... 29 3/11/2021
0.8.0 540 2/8/2021
0.8.0-previe... 32 2/7/2021
0.7.4 86 2/2/2021
0.7.4-previe... 30 2/2/2021
0.7.3 33 2/2/2021
0.7.3-previe... 29 2/2/2021
0.7.3-previe... 29 1/18/2021
0.7.2 229 1/17/2021
0.7.2-previe... 30 1/17/2021
0.7.1 1,205 8/5/2020
0.7.1-previe... 28 8/5/2020
0.7.0 272 7/8/2020
0.7.0-previe... 28 7/8/2020
0.6.1 143 7/1/2020
0.6.1-previe... 28 7/1/2020
0.6.1-previe... 28 6/26/2020
0.6.0 126 6/22/2020
0.6.0-previe... 29 6/22/2020
0.6.0-previe... 28 6/20/2020
0.5.2-previe... 29 6/16/2020
0.5.1 1,284 5/1/2020
0.5.1-previe... 28 5/1/2020
0.5.0 635 3/28/2020
0.5.0-previe... 30 3/27/2020
0.4.1-previe... 30 2/26/2020
0.4.0 178 2/25/2020
0.4.0-previe... 30 2/25/2020
0.4.0-previe... 30 2/25/2020
0.4.0-previe... 30 2/18/2020
0.3.0 56 2/11/2020
0.3.0-previe... 30 2/11/2020
0.2.0 36 2/6/2020
0.1.1 34 2/2/2020
0.1.1-previe... 34 2/2/2020
Show less