Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 2 additions & 46 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,3 @@
# Document-PSModule (by PSModule)
# Document-PSModule

A GitHub Action that automates the generation of documentation for PowerShell modules using Markdown help files.

This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule). It is recommended to use the
[Process-PSModule workflow](https://github.com/PSModule/Process-PSModule) to automate the whole process of managing the PowerShell module.

## Details

This action:
- Installs necessary modules, including `platyPS` for documentation generation.
- Loads helper scripts required by the documentation process.
- Generates Markdown documentation from PowerShell module files.
- Ensures Markdown documentation is properly formatted, with correctly tagged PowerShell code blocks.
- Adjusts Markdown file paths to mirror the structure of the source PowerShell module files.
- Outputs organized Markdown documentation suitable for publishing or distribution.

## Usage

Include this action in your workflow to automatically build and structure documentation for your PowerShell module.

### Inputs

| Input | Description | Required | Default |
|--------------------|-----------------------------------------------|----------|-------------|
| `Name` | Name of the module to document. | No | <Repo name> |
| `WorkingDirectory` | Directory from which the script will execute. | No | `.` |
| `ShowSummaryOnSuccess` | Show GitHub Step Summary even when all commands succeed. | No | `false` |

### Secrets

This action does not require any secrets.

### Outputs

This action does not have defined outputs.

### Example

```yaml
- name: Document PowerShell Module
uses: PSModule/Document-PSModule@v1
with:
Name: 'MyModule'
WorkingDirectory: './module-directory'
ShowSummaryOnSuccess: true # Optional: Show summary even on success
```
This GitHub Action is a part of the [PSModule framework](https://github.com/PSModule).
5 changes: 1 addition & 4 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
name: Document-PSModule (by PSModule)
name: Document-PSModule
description: Build documentation for a PowerShell module.
author: PSModule
branding:
icon: package
color: gray-dark

inputs:
Name:
Expand Down
Loading