Open llucax opened 5 months ago
Make documents that are normally rendered by GitHub, like README.md or CONTRIBUTING.md, as readable and good looking as possible.
README.md
CONTRIBUTING.md
In particular, admonitions are very useful, and GitHub recently added support for Alerts, which are basically admonitions.
The markdown-callouts also recently added support for GitHub Alerts so we can use that extension in files that are rendered by GitHub.
markdown-callouts
The syntax is not as flexible as the markdown extensions admonitions, so we can still use those in docs/ and in docstrings.
docs/
Example:
llucax
commented
4 months ago llucax
commented
4 months ago
What's needed?
Make documents that are normally rendered by GitHub, like
README.mdorCONTRIBUTING.md, as readable and good looking as possible.Proposed solution
In particular, admonitions are very useful, and GitHub recently added support for Alerts, which are basically admonitions.
The
markdown-calloutsalso recently added support for GitHub Alerts so we can use that extension in files that are rendered by GitHub.The syntax is not as flexible as the markdown extensions admonitions, so we can still use those in
docs/and in docstrings.