-
Notifications
You must be signed in to change notification settings - Fork 2.7k
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 - Support more features in Asciidoc -> Mardown converter #43287
Comments
/cc @radcortez (config) |
FWIW, I think it might be a good first issue as it's really tied to the |
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? |
I was told IDEs support Markdown so the goal is to output some not too clever Markdown. I have no actual way to validate what I output. I'll discuss with the IDE people once I have some reasonable examples. |
Exactly: knowing how to view the config docs in an IDE would allow me to figure out whether the output (e.g. for QCXF) makes any sense. |
We probably need to improve on the error reporting as to not fail entirely if we find an icon that is not supported. Related to quarkusio#43287
hello @gsmet i am new to this open source contribution can you guide me |
While I implemented a first version of an AsciiDoc -> Markdown converter here: #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...
The text was updated successfully, but these errors were encountered: