(PDOC-238) add generated message to markdown

Currently there is no evidence in REFERENCE.md itself that it was generated and should not be edited. This adds a comment in the markdown, so as not to disrupt its rendered appearance but still communicate to the user when editing that the file is generated.
parent 2ec1b240
......@@ -13,7 +13,8 @@ module PuppetStrings::Markdown
# generates markdown documentation
# @return [String] markdown doc
def self.generate
final = "# Reference\n\n"
final = "# Reference\n"
final << "<!-- DO NOT EDIT: This document was generated by Puppet Strings -->\n\n"
final << PuppetStrings::Markdown::TableOfContents.render
final << PuppetStrings::Markdown::PuppetClasses.render
final << PuppetStrings::Markdown::DefinedTypes.render
......
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes
......
# Reference
<!-- DO NOT EDIT: This document was generated by Puppet Strings -->
## Classes
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment