Skip to content
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

Support Mmark Asides (mirror Alert Shortcode) #1214

Closed
HughP opened this issue Jul 19, 2019 · 4 comments
Closed

Support Mmark Asides (mirror Alert Shortcode) #1214

HughP opened this issue Jul 19, 2019 · 4 comments
Milestone

Comments

@HughP
Copy link

HughP commented Jul 19, 2019

There doesn't seem to be any default styling for aside elements in post or pages. Is this a correct observation. I looked at the code base for asides and didn't find anything.

I know that BlackFriday does not support asides but mmark does viaA>. And hugo supports both. I was researching mmark for it's reported support for citations relevant to #830.

Should I propose a styling for an aside in the theme?

@gcushen
Copy link
Collaborator

gcushen commented Jul 19, 2019

BlackFriday does not support asides

Academic is currently intended for use only with the built-in Blackfriday Markdown parser.

One can attempt to use Hugo with other Markdown parsers like Mmark and Pandoc if they wish, but officially integrating/testing with these is not on the roadmap. Note that Mmark is not a general Markdown parser and does not have feature parity with either GitHub Markdown or Blackfriday.

If Blackfriday add support, then I'll re-open :)

@gcushen gcushen closed this as completed Jul 19, 2019
@gcushen
Copy link
Collaborator

gcushen commented Jul 20, 2019

Actually, the Hugo docs were out of date on the comparison with Mmark.

After investigating further, I now recommend technical content writers to use Mmark (add markup: mmark to YAML front matter). By using Mmark, there is also no need to escape LaTeX math to prevent it being parsed as Markdown. Hopefully Hugo team update to Mmark v2 as that will bring a lot of much needed technical functionality and fix many current issues.

Consider adding your support for a site wide Mmark option here: gohugoio/hugo#6101

Asides already exist in the form of the Alert shortcode. I have just updated the styles so that A>... in Mmark reflects this.

@gcushen gcushen changed the title Aside styles in theme Support Mmark Asides (mirror Alert Shortcode) Jul 20, 2019
@gcushen gcushen added this to the v4.4 milestone Jul 20, 2019
@gcushen
Copy link
Collaborator

gcushen commented Jul 20, 2019

See it in action in the latest demo of writing technical content: https://academic-demo.netlify.com/post/writing/

@HughP
Copy link
Author

HughP commented Jul 21, 2019 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants