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
Python-Markdown, the library behind MkDocs that parses the markdown files into html, has quite a few extensions available out of the box, with some being used a lot by people.
With that said do some of these extensions have... questionable design choices made, which feel odd to exist the way they are.
A prime example are admonition boxes. They are by far the most used extension in MkDocs, but their syntax is ugly, requiring indentation to denote the content itself for the box, which on sites like GitHub can render as codeblocks, depending on the separation.
Meanwhile extensions like PyMDownX's admonition block exist, which provide a much saner structure that doesn't use indentation (Except for settings), which has a much less severe effect on the raw markdown file's viewed.
So tl;dr: We should consider suggesting the use of alternative extensions to common Python-Markdown ones. Maybe even use some of them ourself in the main documentation.
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
Uh oh!
There was an error while loading. Please reload this page.
-
Python-Markdown, the library behind MkDocs that parses the markdown files into html, has quite a few extensions available out of the box, with some being used a lot by people.
With that said do some of these extensions have... questionable design choices made, which feel odd to exist the way they are.
A prime example are admonition boxes. They are by far the most used extension in MkDocs, but their syntax is ugly, requiring indentation to denote the content itself for the box, which on sites like GitHub can render as codeblocks, depending on the separation.
Meanwhile extensions like PyMDownX's admonition block exist, which provide a much saner structure that doesn't use indentation (Except for settings), which has a much less severe effect on the raw markdown file's viewed.
So tl;dr: We should consider suggesting the use of alternative extensions to common Python-Markdown ones. Maybe even use some of them ourself in the main documentation.
Beta Was this translation helpful? Give feedback.
All reactions