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

Config Doc: use HTML tables to be able to output markdown inside cells #43225

Merged
merged 1 commit into from
Sep 12, 2024

Conversation

Athou
Copy link
Contributor

@Athou Athou commented Sep 11, 2024

This fixes this comment by @gsmet

Sample output of allConfig.qute.md for CommaFeed: https://gist.github.com/Athou/18d9ab535a4d7bebd74d916c4b023407

I think io.quarkus.maven.config.doc.generator.MarkdownFormatter#escapeCellContent may need to be updated to escape HTML to avoid breaking the table cells, but I'm not sure what's the best way to do that.

@quarkus-bot quarkus-bot bot added the area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins label Sep 11, 2024
@gsmet
Copy link
Member

gsmet commented Sep 11, 2024

Looks good. I wonder if you should avoid centering Configuration property and the section name?

Maybe you could use something similar to what I did for Asciidoc and add a number of unbreakable spaces in front of the sections depending on the level? For your simple example, it would just be left aligned but if it goes deeper, they would be indented a bit?

As for escaping HTML, the Javadoc will potentially come as HTML so you can't really do that.

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added a few suggestions and a question.

@quarkus-bot

This comment has been minimized.

Copy link

github-actions bot commented Sep 11, 2024

🎊 PR Preview 155093d has been successfully built and deployed to https://quarkus-pr-main-43225-preview.surge.sh/version/main/guides/

  • Images of blog posts older than 3 months are not available.
  • Newsletters older than 3 months are not available.

@quarkus-bot

This comment has been minimized.

@Athou
Copy link
Contributor Author

Athou commented Sep 11, 2024

I wonder if you should avoid centering Configuration property and the section name?

Maybe you could use something similar to what I did for Asciidoc and add a number of unbreakable spaces in front of the sections depending on the level? For your simple example, it would just be left aligned but if it goes deeper, they would be indented a bit?

Done! I updated the gist with the new output (I have nested configuration items, see Database cleanup settings that is a child of Database settings)

@quarkus-bot
Copy link

quarkus-bot bot commented Sep 11, 2024

Status for workflow Quarkus CI

This is the status report for running Quarkus CI on commit 63b38d0.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

Warning

There are other workflow runs running, you probably need to wait for their status before merging.

You can consult the Develocity build scans.

@quarkus-bot
Copy link

quarkus-bot bot commented Sep 11, 2024

Status for workflow Quarkus Documentation CI

This is the status report for running Quarkus Documentation CI on commit 63b38d0.

✅ The latest workflow run for the pull request has completed successfully.

It should be safe to merge provided you have a look at the other checks in the summary.

@gsmet
Copy link
Member

gsmet commented Sep 12, 2024

Looks really good. Let's drop the new line replacement and it's good to go!

Copy link
Member

@gsmet gsmet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice update, thanks!

@gsmet gsmet merged commit a36ef64 into quarkusio:main Sep 12, 2024
22 checks passed
@quarkus-bot quarkus-bot bot added this to the 3.16 - main milestone Sep 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/devtools Issues/PR related to maven, gradle, platform and cli tooling/plugins
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants