https://github.com/eamonnfaherty/cloudformation-doc-generator
https://github.com/eamonnfaherty/cloudformation-doc-generator
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/eamonnfaherty/cloudformation-doc-generator
- Owner: eamonnfaherty
- Created: 2019-04-12T09:44:49.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2021-02-03T16:46:35.000Z (over 5 years ago)
- Last Synced: 2026-01-05T14:38:20.496Z (6 months ago)
- Language: Python
- Size: 11.7 KB
- Stars: 5
- Watchers: 1
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# What is this?
Installing this tool will provide you with the command ```cfn-docs```.
The command ```cfn-docs``` accepts an AWS CloudFormation template and returns a description of the
template in markdown:
```bash
cfn-docs org-bootstrap.template.yaml > org-bootstrap.template.README.md
```
In the example above we redirect the std out into a file.
## What does it read?
The tool will read the description from the template, each parameter, each resource and each output. It will output
those descriptions in a markdown document under suitable headers. It also lists parameters, resources and outputs
that do not have any descriptions.