cfn-docgen-vsc-extension invokes cfn-docgen via visual studio code's interfaces, and makes it easier to generate and preview documents from cfn template files.
- invoke cfn-docgen command line tool via visual studio code's interfaces.
- make it easy to preview generated documents.
- generate resource definition skeleton for each resources
This extension is just a wrapper for cfn-docgen. So you need to also install cfn-docgen command line tool.
This extension contributes the following settings:
cfn-docgen.OutputRootDirectory
: output root directory for generated documentscfn-docgen.OpenPreview
: if true, automatically open markdown preview right after the document is generatedcfn-docgen.CustomResourceSpecificationPath
: absolute path for your custom resource specification json filecfn-docgen.SkeletonFormat
: skeleton formatcfn-docgen.Debug
: if true, enable debug logging