cloudformation-doc-generator fork

I’ve forked the cloudformation-doc-generator by Eamonn Faherty tonight. This is a very handy tool to convert your cloudformation template into Markdown. From there you can use pandoc to convert the mark down into other formats. I’m finding this one handy for my Design Documentation!

Forked Repo: https://github.com/stormlrd/cloudformation-doc-generator

Original Repo: https://github.com/eamonnfaherty/cloudformation-doc-generator

I’ve made modifications to the output:

• Added a section for Parameters to be listed in a table before being output as a section per param
• Added a section for Resources to be listed in a table before being output as a section per resource
• Added Properties into the Resource sections as a table
• Made the Outputs into a table instead of a section
• Fixed up the template section spacing and line breaks to be pandoc friendly for use with Word
• Fixed up the for loops to output “no resources” or “no params” if there are none defined
• Fixed up the outputs to deal with no Export if non specified

Sample command to generate the markdown from a yaml template:

python cli.py d:\test.yaml > d:\test.md

And then the command for pandoc to convert it into a word doc:

pandoc -o d:\test.docx -f markdown -t docx d:\test.md --toc