-
Notifications
You must be signed in to change notification settings - Fork 103
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
Markdown Admonitions in Docusaurus #184
Comments
hey @jaydm26 , could you give an example of what you would like to be able to write syntactically and what the expected rendered output would be in Markdown format? Is this specific to the Pydoc-Markdown documentation format, or Sphinx or Google? |
Sure! Consider the following within a docstring:
What I was hoping to see when this gets converted to markdown is:
The above is along the lines of admonitions that have been introduced in docusaurus v2. |
Hello!
Currently, all keywords within the docstring of a Python code (e.g. Args, Returns, Warnings, Raises, Notes, etc.) are rendered as boldface text within the generated markdown file.
Since admonitions are supported in docusaurus, I was hoping for an addition of a feature to allow admonitions like Warnings to be rendered as true admonitions (like here).
The text was updated successfully, but these errors were encountered: