-
Notifications
You must be signed in to change notification settings - Fork 2
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
Consider using markdown containers instead of blockquotes #50
Comments
I'll elaborate a little on my discomfort with using blockquotes here:
In general my rule of portability for markdown extensions is not so much "will any markdown system I try to use in the future be able to render this exactly as my current one does?"—which is a pretty limiting rule since Markdown at its core was really only designed to capture the sort of rich formatting one might use in the text of an email, not documentation or blog posts—but "Will any human looking at this in the future understand what the intention was of this syntax?" Extensions can always be recreated if the intention is understood and if the future escape hatch is just rendering something as plain text, that's often fine as well. I do prefer markdown-it-container for my own projects, but I think there's a good argument for using the GitHub-flavored admonition syntax instead since GitHub-flavored Markdown is very common. This |
@harrislapiroff suggested using Markdown containers, instead of blockquotes, via the
markdown-it-container
project. Let's weigh the pros and cons, and go with a solution for our future projects.(original discussion here: #48 (comment))
The text was updated successfully, but these errors were encountered: