PSDocs.Azure

February 25, 2022 ยท View on GitHub

Build Status VSCode Extension

Generate documentation from Infrastructure as Code (IaC). PSDocs for Azure automatically generates documentation for Azure infrastructure as code (IaC) artifacts.

Please review the Requirements to ensure you can use this extension successfully.

Note: this extension is in preview.

Features

Command Palette

You can generate markdown files directly from an ARM template through the Command Pallette. Simply press Ctrl+Shift+P (Win/Linux) or Command+Shift+P (MacOS) and type in PSDocs.Azure: Generate Markdown

Generate Markdown

You will first be asked to provide a full path to the ARM template. The prompt auto-populates with the full path of the currently opened file.

Provide full path to the ARM template file

Additionally, you will be asked to provide a relative path (from the ARM template) to store the generated markdown.

Provide destination relative path where markdown will be created

The markdown will be created in the folder relative to the the ARM template file.

Snippets

Adds snippets for adding metadata tag within ARM templates.

  • psdocs-arm can be used to add metadata at the template root schema
  • psdocs-arm-short can be used to add metadata anywhere else e.g. parameters or variables

PSDocs.Azure Template

PSDocs.Azure Template

Requirements

PSDocs.Azure is required for this extension to work.

To install the module use the following command from a PowerShell prompt.

Install-Module -Name PSDocs.Azure -Scope CurrentUser;

Known Issues and Limitations

  • The extension is in preview and therefore has not undergone extended testing scenarios.
  • Only one markdown can be generated at one time.
  • A separate directory should be used to avoid overriding the Generated Markdown --> README.md file.
  • Additional PSDocs.Azure configuration is not supported at this time.

Release Notes

Refer to CHANGELOG

Contributing

This project welcomes contributions and suggestions. If you are ready to contribute, please visit the contribution guide.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Maintainers

License

This project is licensed under the MIT License.