search

seqeralabs / terraform-seqera-aws

Apache License 2.0
5 stars 3 forks source link

Add syntax highlighting to README.md #10

Closed ewels closed 10 months ago

ewels commented 10 months ago
Before After
CleanShot 2023-11-10 at 11 50 50@2x CleanShot 2023-11-10 at 11 51 19@2x
ewels commented 10 months ago

The inline JSON with newline characters is also kind of impossible to read:

I wonder if it makes sense to have these as nicer JSON blocks within expanding <details> sections at the bottom of the readme, with headings that we link to from the table instead?

enekui commented 10 months ago

Hey @ewels,

Thanks for the contribution, but the README.md is automatically generated by terraform-docs. So, for these changes to appear in the README.md we need to make these changes in the file .header.md :)

enekui commented 10 months ago

Please, make the changes on the file .header.md. And I will approve the PR.

ewels commented 10 months ago

Done 👍🏻