{"id":15012677,"url":"https://github.com/microsoft/ps-docs","last_synced_at":"2025-06-17T22:38:38.833Z","repository":{"id":48196857,"uuid":"382859338","full_name":"microsoft/ps-docs","owner":"microsoft","description":"Generate documentation from Infrastructure as Code (IaC) using GitHub Actions.","archived":false,"fork":false,"pushed_at":"2023-08-11T12:21:45.000Z","size":23,"stargazers_count":23,"open_issues_count":3,"forks_count":5,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-06-13T00:12:37.724Z","etag":null,"topics":["devops","devops-tools","documentation-generator","github-actions","infrastructure-as-code","markdown","psdocs"],"latest_commit_sha":null,"homepage":"https://github.com/marketplace/actions/ps-docs","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/microsoft.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":"SUPPORT.md","governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-04T13:30:56.000Z","updated_at":"2025-04-03T19:48:13.000Z","dependencies_parsed_at":"2024-06-20T23:23:47.901Z","dependency_job_id":null,"html_url":"https://github.com/microsoft/ps-docs","commit_stats":{"total_commits":17,"total_committers":3,"mean_commits":5.666666666666667,"dds":0.5294117647058824,"last_synced_commit":"333fc57dfef2479e0c6457600bb4c7a1316783ba"},"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/microsoft/ps-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fps-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fps-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fps-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fps-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/ps-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fps-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260452754,"owners_count":23011541,"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":["devops","devops-tools","documentation-generator","github-actions","infrastructure-as-code","markdown","psdocs"],"created_at":"2024-09-24T19:43:03.802Z","updated_at":"2025-06-17T22:38:33.819Z","avatar_url":"https://github.com/microsoft.png","language":"PowerShell","readme":"# PSDocs\n\nGenerate documentation from Infrastructure as Code (IaC) using PSDocs.\nPSDocs allows you to dynamically generate markdown from infrastructure code artifacts.\nUse pre-build modules or build your own.\n\nTo learn about PSDocs and how you can build documentation dynamically see [Getting started](https://github.com/microsoft/PSDocs#getting-started).\n\n## Usage\n\nTo get the latest stable release use:\n\n```yaml\n- name: Generate docs\n  uses: Microsoft/ps-docs@v0.1.0\n```\n\nTo get the latest bits use:\n\n```yaml\n- name: Generate docs\n  uses: Microsoft/ps-docs@main\n```\n\nFor a list of changes please see the [change log].\n\n## Inputs\n\n```yaml\n- name: Generate docs\n  uses: Microsoft/ps-docs@main\n  with:\n    inputPath: string       # Optional. The path PSDocs will look for files to input files.\n    modules: string         # Optional. A comma separated list of modules to use containing document definitions.\n    source: string          # Optional. An path containing definitions to use for generating documentation.\n    conventions: string     # Optional. A comma separated list of conventions to use for generating documentation.\n    outputPath: string      # Optional. The path to write documentation to.\n    path: string            # Optional. The working directory PSDocs is run from.\n    prerelease: boolean     # Optional. Determine if a pre-release module version is installed.\n```\n\n### `inputPath`\n\nThe path PSDocs will look for files to input files.\nDefaults to repository root.\n\n### `modules`\n\nA comma separated list of modules to use containing document definitions.\n\nModules are additional packages that can be installed from the PowerShell Gallery.\nPSDocs will install the latest **stable** version from the PowerShell Gallery automatically by default.\n[Available modules](https://www.powershellgallery.com/packages?q=Tags%3A%22PSDocs-documents%22).\n\nTo install pre-release module versions, use `prerelease: true`.\n\n### `source`\n\nAn path containing definitions to use for generating documentation.\nDefaults to `.ps-docs/`.\n\nUse this option to include document definitions that have not been packaged as a module.\n\n### `conventions`\n\nA comma separated list of conventions to use for generating documentation.\n\nConventions are code blocks that provide extensibility and integration.\nThey can be included in `.Doc.ps1` files from `.ps-docs/` or modules.\n\nSee [about_PSDocs_Conventions][2] for more information.\n\n  [2]: https://github.com/microsoft/PSDocs/blob/main/docs/concepts/PSDocs/en-US/about_PSDocs_Conventions.md\n\n### `outputPath`\n\nThe path to write documentation to.\n\n### `path`\n\nThe working directory PSDocs is run from.\nDefaults to repository root.\n\nOptions specified in `ps-docs.yaml` from this directory will be used unless overridden by inputs.\n\n### `prerelease`\n\nDetermine if a pre-release rules module version is installed.\nWhen set to `true` the latest pre-release or stable module version is installed.\n\nIf this input is not configured, invalid, or set to `false` only stable module versions will be installed.\n\n## Using the action\n\nTo use PSDocs:\n\n1. See [Creating a workflow file](https://help.github.com/en/articles/configuring-a-workflow#creating-a-workflow-file).\n2. Reference `Microsoft/ps-docs@main`.\nFor example:\n\n```yaml\nname: CI\non: [push]\njobs:\n  docs:\n    runs-on: ubuntu-latest\n    steps:\n\n    - name: Checkout\n      uses: actions/checkout@main\n\n    - name: Generate docs\n      uses: Microsoft/ps-docs@main\n```\n\n3. Run the workflow.\n\n## Contributing\n\nThis project welcomes contributions and suggestions. Most contributions require you to\nagree to a Contributor License Agreement (CLA) declaring that you have the right to,\nand actually do, grant us the rights to use your contribution. For details, visit\nhttps://cla.microsoft.com.\n\nWhen you submit a pull request, a CLA-bot will automatically determine whether you need\nto provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the\ninstructions provided by the bot. You will only need to do this once across all repositories using our CLA.\n\n## Code of Conduct\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)\nor contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n## Maintainers\n\n- [Bernie White](https://github.com/BernieWhite)\n- [Vic Perdana](https://github.com/vicperdana)\n\n## License\n\nThis project is [licensed under the MIT License](LICENSE).\n\n[change log]: CHANGELOG.md\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fps-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fps-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fps-docs/lists"}