There has been a documentation "regression" from my PR #48. The rendering of warnings and notes look good on GitHub (since they use the GitHub syntax) but do not look good when rendered via MkDocs.
Is this something we need to care about in the long run? I figure most of them will disappear as we author documentation on the relevant pages, and as the project matures.
Alternatively, there might be a MkDocs plugin for parsing the GitHub syntax warnings and notes. There might also be some way to only render GitHub syntax on GitHub, and only MkDocs syntax on MkDocs.
This issue is raised to highlight the change.
How the variants look
Current on GitHub
Current on MkDocs
Old on GitHub
Old on MkDocs
There has been a documentation "regression" from my PR #48. The rendering of warnings and notes look good on GitHub (since they use the GitHub syntax) but do not look good when rendered via MkDocs.
Is this something we need to care about in the long run? I figure most of them will disappear as we author documentation on the relevant pages, and as the project matures.
Alternatively, there might be a MkDocs plugin for parsing the GitHub syntax warnings and notes. There might also be some way to only render GitHub syntax on GitHub, and only MkDocs syntax on MkDocs.
This issue is raised to highlight the change.
How the variants look
Current on GitHub
Current on MkDocs
Old on GitHub
Old on MkDocs