@ccampo133 I found the issue - the docs' example code has trailing spaces following <!-- END_TF_DOCS -->. I'll open a PR.

Upon further inspection, it's not a fault in the documentation as it's written. It's an issue with how the code blocks are rendered on terraform-docs.io. If you copy the contents from the site, it includes a lot of trailing spaces:

However, the code itself doesn't actually have trailing spaces. This appears to only be an issue with HTML comment blocks, not anything else.

This has to do with how the site is rendered and I have no clue how to work with that. Hopefully this helps people figure out this problem, at least.

@ccq1994 confirmed that removing the trailing spaces does appear to resolve the issue I reported. Thanks for tracking that down!

I think it would make sense to have the code ignore/trim any whitespace following the comment.

I opened a PR for this here: #658

If you intent to write a newline after <!-- END_TF_DOCS --> i.e. the template <!-- BEGIN_TF_DOCS -->\n{{ .Content }}\n<!-- END_TF_DOCS -->\n will the fix in #658 still work?

If the newline is missing, this is something that git clients will tell you about, like explained here: https://stackoverflow.com/questions/5813311/whats-the-significance-of-the-no-newline-at-end-of-file-log

@nikolaik yes, although I'm not sure that your question is relevant to this issue. The template in question here must be passed in the YAML file, under the output.template key - it cannot live in its own file. You can have an arbitrary amount of newlines at the end of the template block and this will work, and so far as I can tell, this has always worked, for example:

.terraform-docs.yaml:

formatter: "markdown"

output:
  file: "README.example.md"
  template: |-
    <!-- BEGIN_TF_DOCS -->
    {{ .Content }}
    <!-- END_TF_DOCS -->

  mode: inject

@EppO @blakegong @khos2ow any chance this issue and corresponding PR could be merged? Or is this project unmaintained at this point?

is the related fix going to be merged ? @EppO @blakegong @khos2ow

@RuiSMagalhaes I'd love to see it merged, but I don't think the project is actively maintained. However the workaround for now is simple - just to remove any extra whitespace from the template manually (see #652 (comment)).