{"id":13599370,"url":"https://github.com/StartAutomating/HelpOut","last_synced_at":"2025-04-10T12:32:26.747Z","repository":{"id":36985077,"uuid":"192608060","full_name":"StartAutomating/HelpOut","owner":"StartAutomating","description":"A Helpful Toolkit for Managing PowerShell Help","archived":false,"fork":false,"pushed_at":"2024-10-13T22:51:22.000Z","size":864,"stargazers_count":32,"open_issues_count":20,"forks_count":4,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T04:51:23.379Z","etag":null,"topics":["markdown","powershell","powershell-help","powershell-helper"],"latest_commit_sha":null,"homepage":"https://helpout.start-automating.com","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/StartAutomating.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["StartAutomating"]}},"created_at":"2019-06-18T20:27:10.000Z","updated_at":"2024-10-28T13:36:56.000Z","dependencies_parsed_at":"2023-01-17T12:15:46.807Z","dependency_job_id":"a44c5b23-ccbe-44db-a97d-f446d28b957a","html_url":"https://github.com/StartAutomating/HelpOut","commit_stats":{"total_commits":902,"total_committers":3,"mean_commits":300.6666666666667,"dds":"0.24611973392461195","last_synced_commit":"171343855c1579d26402dc5be6466203b916c33e"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/StartAutomating%2FHelpOut/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/StartAutomating","download_url":"https://codeload.github.com/StartAutomating/HelpOut/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248217145,"owners_count":21066633,"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":["markdown","powershell","powershell-help","powershell-helper"],"created_at":"2024-08-01T17:01:03.037Z","updated_at":"2025-04-10T12:32:21.736Z","avatar_url":"https://github.com/StartAutomating.png","language":"PowerShell","readme":"\u003cdiv align='center'\u003e\n\u003cimg src='Assets/HelpOut.svg' alt='HelpOut' /\u003e\n\u003ca href='https://www.powershellgallery.com/packages/HelpOut/'\u003e\n\u003cimg src='https://img.shields.io/powershellgallery/dt/HelpOut' /\u003e\n\u003c/a\u003e\n\u003c/div\u003e\n\n## A Helpful Toolkit for Managing PowerShell Help\n\nHelpOut is a Helpful Toolkit for Managing PowerShell Help.\n\nIt helps you to:\n\n* Make Markdown Documentation and Wikis For Your Module\n* Measure how much documentation is in a script or a function\n* Find references within a script.\n\nYou can install HelpOut from the gallery, or use it as a GitHub Action.\n\n## HelpOut as a GitHub action\n\nTo use HelpOut as a GitHub action, simply copy/paste this code into a job in your workflow\n\n~~~yaml\n   - name: UseHelpOut\n     uses: StartAutomating/HelpOut@master\n~~~\n\nThen, create a `*.HelpOut.ps1` file.\n\nThis file should import your module and then use Save-MarkdownHelp with -PassThru\n\nFiles produced this way will be checked in if there are any changes.\n\n**NOTE** You must allow repository write permissions to your GitHub Workflow for HelpOut to update files.\n\n## Using HelpOut Locally\n\nTo use HelpOut locally, start off by installing it from the PowerShell Gallery:\n\n~~~PowerShell\nInstall-Module HelpOut -Scope CurrentUser -Force\n~~~\n\n### Generating MAML\n~~~PowerShell\nGet-Module HelpOut | Save-Maml # Will generate MAML files for all of the commands in HelpOut\n~~~\n\n### Generating Markdown /docs\n~~~PowerShell\nGet-Module HelpOut | Save-MarkdownHelp  # Will generate a /docs folder containing markdown help (interlinked for GitHub Pages)\n~~~\n\n### Generating Wikis\n~~~PowerShell\nGet-Module HelpOut | Save-MarkdownHelp -Wiki  # Will generate a ../HelpOut.wiki folder containing markdown help (interlinked for wikis)\n~~~\n\n\n### Using HelpOut as a GitHub Action.\n\nYou can use HelpOut as a GitHub Action.  Doing so will run whatever .HelpOut.ps1 files exist in your repository.  If a -CommitMessage is provided, or attached to any files returned by the .HelpOut.ps1, the changes will be commited.\n","funding_links":["https://github.com/sponsors/StartAutomating"],"categories":["PowerShell"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStartAutomating%2FHelpOut","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FStartAutomating%2FHelpOut","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FStartAutomating%2FHelpOut/lists"}