{"id":17867094,"url":"https://github.com/cdhunt/build-docs","last_synced_at":"2026-02-13T06:39:41.919Z","repository":{"id":212733411,"uuid":"732185209","full_name":"cdhunt/Build-Docs","owner":"cdhunt","description":"Helper for building markdown docs from PowerShell Command Help","archived":false,"fork":false,"pushed_at":"2024-12-30T17:18:08.000Z","size":39,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-10-29T01:36:55.669Z","etag":null,"topics":["build-tool","powershell"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/cdhunt.png","metadata":{"files":{"readme":"README.md","changelog":"Changelog.md","contributing":null,"funding":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2023-12-15T21:34:37.000Z","updated_at":"2024-12-30T17:18:11.000Z","dependencies_parsed_at":"2023-12-15T22:48:40.971Z","dependency_job_id":"14e6449e-4671-44e5-bc8f-2061945a4cb7","html_url":"https://github.com/cdhunt/Build-Docs","commit_stats":null,"previous_names":["cdhunt/build-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/cdhunt/Build-Docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdhunt%2FBuild-Docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdhunt%2FBuild-Docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdhunt%2FBuild-Docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdhunt%2FBuild-Docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cdhunt","download_url":"https://codeload.github.com/cdhunt/Build-Docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cdhunt%2FBuild-Docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29398144,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-13T06:24:03.484Z","status":"ssl_error","status_checked_at":"2026-02-13T06:23:12.830Z","response_time":78,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["build-tool","powershell"],"created_at":"2024-10-28T09:43:48.915Z","updated_at":"2026-02-13T06:39:41.896Z","avatar_url":"https://github.com/cdhunt.png","language":"PowerShell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Build-Docs\n\nHelper for building markdown docs from PowerShell Command Help.\n\n## CI Status\n\n[![PowerShell](https://github.com/cdhunt/Build-Docs/actions/workflows/powershell.yml/badge.svg)](https://github.com/cdhunt/Build-Docs/actions/workflows/powershell.yml)\n\n## Install\n\n[powershellgallery.com/packages/Build-Docs](https://www.powershellgallery.com/packages/Build-Docs)\n\n`Install-Module -Name Build-Docs` or `Install-PSResource -Name Build-Docs`\n\n## Docs\n\n[Full Docs](docs)\n\n### Getting Started\n\nThis module will walk the properties and help for each command in a given module and add a `.ToMD()` ScriptMethod that applies some opinionated markdown formatting.\nThe is entirely based on the output of [Get-Help](https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/get-help?view=powershell-7.4) so the help data can be XML-based or comment-based.\n\nThis module adds the `.ToMD()` method to the following command help properties.\nOnly properties that are defined are rendered into markdown so you won't have a bunch of empty sections if not defined.\n\n- `Description`\n- `ParameterSet` _(each)_: Adds an H3 header for each parameter set which contains a unordered list of parameters.\n- `Example` _(each)_: All of the text before an empty newline is considered part of the code and will be fenced in a code block. Text after an empty newline is considered the Remarks.\n- `Link` _(each)_: Format as a HREF link. If the link text is an existing command in the module it will link to `{commandname}.md`.\n- `Note`\n- `Output`\n\n### Example Usage\n\nThis is the basic snippet I use in my `build.ps1` scripts to generate all the files under `/docs`.\n\n```powershell\n$help = Get-HelpModuleData $module\n\n# docs/README.md\n$help | New-HelpDoc |\nAdd-ModuleProperty Name -H1 |\nAdd-ModuleProperty Description |\nAdd-HelpDocText \"Commands\" -H2 |\nAdd-ModuleCommand -AsLinks |\nOut-HelpDoc -Path 'docs/README.md'\n\n# Individual Commands\nforeach ($command in $help.Commands) {\n    $name = $command.Name\n    $doc = New-HelpDoc -HelpModuleData $help\n    $doc.Text = $command.ToMD()\n    $doc | Out-HelpDoc -Path \"docs/$name.md\"\n}\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdhunt%2Fbuild-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcdhunt%2Fbuild-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcdhunt%2Fbuild-docs/lists"}