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

Concatenate output in single file #717

Open
cuthbeorht opened this issue Oct 25, 2023 · 0 comments
Open

Concatenate output in single file #717

cuthbeorht opened this issue Oct 25, 2023 · 0 comments

Comments

@cuthbeorht
Copy link

What problem are you facing?

I am working on a large-ish terraform project. I would like to document it automagically using terraform-docs. I would also like to package this generated markdown so it can be sent as a single file somewhere else. Right now, the tool generates a markdown file in each module & sub-module.

How could terraform-docs help solve your problem?

Maybe I read the docs for the config wrong, but is there a way to force the output of the generated documentation to a single file instead of each module/sub-module? If not, is feasible to have a config option to do so?

Example:

...
settings:
  force-single-file-mode: true
...

The property name is just a suggestion. I'm sure there are better ones. 😉

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

No branches or pull requests

1 participant