-
Notifications
You must be signed in to change notification settings - Fork 23
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
Wishlist: Markdown syntax #37
Comments
Thank you for the suggestion. There is an upcoming refactor of the comment parsing system where we're hoping to support richer forms of markup, including Markdown, in comments. |
Allo ! Has there been updates on this ? I think it would be extremely beneficial to library documentations if we could have access to richer syntax to specific examples and other miscellaneous information about the code ? Thank you |
Hello, This is something we are working on, however we can't provide an exact date that it will be ready right now. Thank you |
hdoc supports (some of) doxygen syntax, which makes sense.
But instead, I would like to write documentation in the syntax of Rustdoc, which doesn't require a lot of keywords. Instead it uses markdown syntax: https://doc.rust-lang.org/rust-by-example/meta/doc.html#doc-comments.
This could be a runtime option since being backward compat with doxygen seems like an important thing.
An example comment that uses the
# Header
syntax in markdown, in this case# Safety
which should appear on its own line bolded then: https://docs.hdoc.io/danakj/subspace/r3642BA3A7BB0524E.html#D5D58BB0594AEC21The text was updated successfully, but these errors were encountered: