Add more Markdown backends #179
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LukeMoll
added
the
backend
|
testcase for the various markdown renderers: https://www.hacksoc.org/news/2021-05-25-moving-to-libera.html, specifically does |
|
That was in fact the article that made me aware of the problem, and I did use it while setting up the new backends 😅 |
|
i definitely thought it had been brought up somewhere, yeah, but i couldn't find any references to it – i guess maybe it got slacked |
sersorrel
approved these changes
Mar 7, 2022
|
|
||
| ``` | ||
| # Equivalent; markdown2 is the default backend | ||
| hacksoc_org run | ||
| hacksoc_org run --markdown markdown2 | ||
| hacksoc_org run --markdown markdown2 |
There was a problem hiding this comment.
super minor nitpick
Suggested change
| hacksoc_org run --markdown markdown2 | |
| hacksoc_org run --markdown markdown2 |
Comment on lines
+67
to
+68
| ``` | ||
| #### Markdown2 (Current default) |
There was a problem hiding this comment.
Suggested change
| ``` | |
| #### Markdown2 (Current default) | |
| ``` | |
| #### Markdown2 (Current default) |
Comment on lines
+76
to
+77
| Fork of the CommonMark reference implementation, maintained by GitHub to provide [GFM](https://github.github.com/gfm/) features. Only provides syntax highlighing for the client-side, by adding a (eg.) `lang="py"` attribute to `<pre>` blocks for a JavaScript library to parse and highlight. | ||
| #### CommonMark |
There was a problem hiding this comment.
Suggested change
| Fork of the CommonMark reference implementation, maintained by GitHub to provide [GFM](https://github.github.com/gfm/) features. Only provides syntax highlighing for the client-side, by adding a (eg.) `lang="py"` attribute to `<pre>` blocks for a JavaScript library to parse and highlight. | |
| #### CommonMark | |
| Fork of the CommonMark reference implementation, maintained by GitHub to provide [GFM](https://github.github.com/gfm/) features. Only provides syntax highlighing for the client-side, by adding a (eg.) `lang="py"` attribute to `<pre>` blocks for a JavaScript library to parse and highlight. | |
| #### CommonMark |
Comment on lines
+82
to
+83
| **Does not support tables**. | ||
| #### Mistletoe |
There was a problem hiding this comment.
Suggested change
| **Does not support tables**. | |
| #### Mistletoe | |
| **Does not support tables**. | |
| #### Mistletoe |
Comment on lines
+86
to
+87
| Gives an example integration of Pygments for syntax highlighing, adapted into [`mistletoe_pygments_renderer.py`](../hacksoc_org/markdown/mistletoe_pygments_renderer.py) | ||
| #### Markdown-it |
There was a problem hiding this comment.
Suggested change
| Gives an example integration of Pygments for syntax highlighing, adapted into [`mistletoe_pygments_renderer.py`](../hacksoc_org/markdown/mistletoe_pygments_renderer.py) | |
| #### Markdown-it | |
| Gives an example integration of Pygments for syntax highlighing, adapted into [`mistletoe_pygments_renderer.py`](../hacksoc_org/markdown/mistletoe_pygments_renderer.py) | |
| #### Markdown-it |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds the following (CommonMark-compliant) Markdown backends:
cmarkcommonmarkmistletoemarkdown-it-pyAt some point in the future, the goal will be to switch to one of these (or another CommonMark implementation). This PR does not intend to change the default backend, but to provide the tools to evaluate a replacement for a future PR to switch to.
TODO
docs/Pygments) is preferred to simply tagging<pre>blocks for a JavaScript-based highlighter to process on the client-side.