File tree Expand file tree Collapse file tree 1 file changed +5
-5
lines changed
Expand file tree Collapse file tree 1 file changed +5
-5
lines changed Original file line number Diff line number Diff line change 11# Document-PSModule (by PSModule)
22
3- A GitHub Action that automates the generation of documentation for PowerShell modules using markdown help files.
3+ A GitHub Action that automates the generation of documentation for PowerShell modules using Markdown help files.
44
55This GitHub Action is a part of the [ PSModule framework] ( https://github.com/PSModule ) . It is recommended to use the
66[ Process-PSModule workflow] ( https://github.com/PSModule/Process-PSModule ) to automate the whole process of managing the PowerShell module.
@@ -10,10 +10,10 @@ This GitHub Action is a part of the [PSModule framework](https://github.com/PSMo
1010This action:
1111- Installs necessary modules, including ` platyPS ` for documentation generation.
1212- Loads helper scripts required by the documentation process.
13- - Generates markdown documentation from PowerShell module files.
14- - Ensures markdown documentation is properly formatted, with correctly tagged PowerShell code blocks.
15- - Adjusts markdown file paths to mirror the structure of the source PowerShell module files.
16- - Outputs organized markdown documentation suitable for publishing or distribution.
13+ - Generates Markdown documentation from PowerShell module files.
14+ - Ensures Markdown documentation is properly formatted, with correctly tagged PowerShell code blocks.
15+ - Adjusts Markdown file paths to mirror the structure of the source PowerShell module files.
16+ - Outputs organized Markdown documentation suitable for publishing or distribution.
1717
1818## Usage
1919
You can’t perform that action at this time.
0 commit comments