Terraform-Docs Visual Studio Code Extension

This visual studio code extension uses Terraform-Docs to generate documentation for Terraform projects.

Please report any issues using this pluginn here.

Table of Contents

• Features
• Requirements
• Product Roadmap

Features

This product will generate Terraform project documentation within Visual Studio Code

To generate documentation for a Terraform project, right-click on the folder containing Terraform code.

.terraform-docs.yml configurations are honored.

If you provide a .terraform-docs.yml configuration file for terraform-docs (to control formatting and output), it will be used in the generation. It must be in located in the folder containing Terraform code to be documented.

If you do not provide a terraform-docs configuration file, markdown will be generated and the output file will be named README.md.

System Requirements

Terraform-Docs must be installed.

Installation instructions are here

Product Roadmap

• Provide settings for:
  • terraform-docs configuration location