You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The function get_all_rules() lists a large number of Markdown rules that can be enabled / disabled. But I can't seem to find a list of these in the docs. It would be very helpful if the docs give examples of the corresponding Markdown tags and what they look like when rendered to HTML.
I also wonder if some of these rules have options e.g. if the heading rule can enable/disable only some of the heading-types?
Thanks!
Proposal
No response
Tasks and updates
No response
The text was updated successfully, but these errors were encountered:
I mean this as a friendly response, but it is perhaps not so realistic to expect outsiders to write your docs :-) We all have a lot of work to do, and it would take other people a disproportionate amount of time to understand your code in order to be able to document it properly. Instead allow me to elaborate on what I would find useful in your docs:
You already have a list in this section with the output from get_all_rules(), but not an explanation of what they do. It would be very helpful if you simply make a list of all these rules, their corresponding markdown tags, short examples, and links to the Markdown specs for a full explanation. Then it is much easier to enable / disable the Markdown rules we need.
I took a look at the file smartquotes.md you linked to, but I have no idea what that is :-)
Context
The function
get_all_rules()
lists a large number of Markdown rules that can be enabled / disabled. But I can't seem to find a list of these in the docs. It would be very helpful if the docs give examples of the corresponding Markdown tags and what they look like when rendered to HTML.I also wonder if some of these rules have options e.g. if the
heading
rule can enable/disable only some of the heading-types?Thanks!
Proposal
No response
Tasks and updates
No response
The text was updated successfully, but these errors were encountered: