Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Markdown without trailing line-break #515

Open
Spreadcat opened this issue Jun 2, 2021 · 3 comments
Open

Markdown without trailing line-break #515

Spreadcat opened this issue Jun 2, 2021 · 3 comments
Labels

Comments

@Spreadcat
Copy link

Describe the bug

When rendering a markdown document from terraform-code, the output file does not have a trailing newline at the end.

$ terraform-docs markdown . > output.md
$ tail output.md
foo
bar

Multiple markdown-linter have rules that require a newline at the end of the file and also the Posix standard defines a line that way.

How can we reproduce it?

  • generate a markdown output file.

Environment information

  • terraform-docs version: 0.12.1/0.14.1
@Spreadcat Spreadcat added the bug label Jun 2, 2021
@quulah
Copy link

quulah commented Dec 3, 2021

I tried to add this with the output.template option, but then the configuration parser complains about missing end comment.

@ccampo133
Copy link

@quulah regarding your issue, I just ran into it and created a bug for it: #652

@Malonsow
Copy link

Malonsow commented Nov 20, 2023

To circumvent the current behavior of the missing trailing newline, I am inserting the {{ .Footer }} block at the end of the content which is empty and therefore inserts the newline for me 😄
But of course I would be happy if this gets fixed one day.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants