Open gsmet opened 1 week ago
/cc @radcortez (config)
FWIW, I think it might be a good first issue as it's really tied to the core/processor
module and might be easier with some AI help.
@ppalaga it would be helpful if you could have a look at what I did here: https://github.com/quarkusio/quarkus/pull/42677/commits/10ffdcb30e602b18990cd8e76a7d31a170341fd6 and add more things that we need to support.
Thanks for the heads up, @gsmet. I wonder whether you have any good method to validate the output for a given extension? My understanding is that it is supposed to output some structured output for IDEs. Are there some (which) IDEs supporting that format already? Do I need some specific IDE plugin to view the rendered config property docs?
While I implemented a first version of an AsciiDoc -> Markdown converter here: https://github.com/quarkusio/quarkus/pull/42677 (see specific commit introducing the
asciidocToMarkdown
method inJavadocToMarkdownTransformer
), there are still features that we need to support...A good example of what we need is in the https://quarkus.io/guides/hibernate-search-orm-elasticsearch#configuration-reference-main where Yoann had a lot of fun.
{hibernate-search-docs-url}
. They would have to be obtained from the Maven properties as they are currently defined there and we want to be consistent.|
marker so we would have to support whatever is there):Given the complexity of these tables, we won't be able to render them as plain Markdown tables so they will have to be rendered as HTML. We might not be able to render all the subtleties in Markdown (typically not sure if we can center things when using HTML in Markdow...). It should be rendered as:
And probably more to follow...