-
Notifications
You must be signed in to change notification settings - Fork 2.8k
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
Conversation
Looks good. I wonder if you should avoid centering 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. |
There was a problem hiding this 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.
...onfig-doc-maven-plugin/src/main/resources/templates/markdown/default/configReference.qute.md
Outdated
Show resolved
Hide resolved
...ig-doc-maven-plugin/src/main/resources/templates/markdown/default/tags/configSection.qute.md
Outdated
Show resolved
Hide resolved
...-doc-maven-plugin/src/main/java/io/quarkus/maven/config/doc/generator/MarkdownFormatter.java
Outdated
Show resolved
Hide resolved
This comment has been minimized.
This comment has been minimized.
🎊 PR Preview 155093d has been successfully built and deployed to https://quarkus-pr-main-43225-preview.surge.sh/version/main/guides/
|
This comment has been minimized.
This comment has been minimized.
a3cd62d
to
63b38d0
Compare
Done! I updated the gist with the new output (I have nested configuration items, see |
Status for workflow
|
Status for workflow
|
Looks really good. Let's drop the new line replacement and it's good to go! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice update, thanks!
This fixes this comment by @gsmet
Sample output of
allConfig.qute.md
for CommaFeed: https://gist.github.com/Athou/18d9ab535a4d7bebd74d916c4b023407I 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.