Markdown writer: Cleaner (code)blocks with single class #7242
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
jtojnar
force-pushed
the
md-simple-block-class
branch
2 times, most recently
from
0938bb6
to
5f21098
Compare
When a block only has a single class and no other attributes, it is not necessary to wrap the class attribute in curly braces – the class name can be placed after the opening mark as is. This will result in bit cleaner output when pandoc is used as a markdown pretty-printer.
jtojnar
force-pushed
the
md-simple-block-class
branch
from
5f21098
to
6dc4e11
Compare
jtojnar
commented
Apr 24, 2021
| @@ -513,7 +519,7 @@ blockToMarkdown' opts (CodeBlock attribs str) = do | |||
| backticks = endline '`' | |||
| tildes = endline '~' | |||
| attrs = if isEnabled Ext_fenced_code_attributes opts | |||
| then nowrap $ " " <> attrsToMarkdown attribs | |||
| then nowrap $ " " <> classOrAttrsToMarkdown attribs | |||
There was a problem hiding this comment.
I wonder if I should keep the space in case of single class. Traditionally, there is not one.
There was a problem hiding this comment.
Cool, looks like it is just as widely supported too: https://babelmark.github.io/?text=%60%60%60+nix%0Afoo%0A%60%60%60 vs https://babelmark.github.io/?text=%60%60%60nix%0Afoo%0A%60%60%60
|
Thanks! |
jtojnar
added a commit
to jtojnar/pandoc
that referenced
this pull request
Jun 5, 2021
In jgm#7242, we introduced a simple attribute style for for code blocks and fenced divs with a single class but turns out the CommonMark extension does not support it for fenced divs. https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/fenced_divs.md
jtojnar
added a commit
to jtojnar/pandoc
that referenced
this pull request
Jun 5, 2021
In jgm#7242, we introduced a simple attribute style for for code blocks and fenced divs with a single class but turns out the CommonMark extension does not support it for fenced divs. https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/fenced_divs.md
jtojnar
added a commit
to jtojnar/pandoc
that referenced
this pull request
Jun 5, 2021
In jgm#7242, we introduced a simple attribute style for for code blocks and fenced divs with a single class but turns out the CommonMark extension does not support it for fenced divs. https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/fenced_divs.md
jgm
pushed a commit
that referenced
this pull request
Jun 5, 2021
In #7242, we introduced a simple attribute style for for code blocks and fenced divs with a single class but turns out the CommonMark extension does not support it for fenced divs. https://github.com/jgm/commonmark-hs/blob/master/commonmark-extensions/test/fenced_divs.md
jgm
reviewed
Jun 21, 2021
| -- | (Code) blocks with a single class can just use it standalone, | ||
| -- no need to bother with curly braces. | ||
| classOrAttrsToMarkdown :: Attr -> Doc Text | ||
| classOrAttrsToMarkdown ("",[cls],_) = literal cls |
There was a problem hiding this comment.
This needed to check also for empty attributes: see #7397
ickc
added a commit
to ickc/pantable
that referenced
this pull request
Jul 3, 2021
jgm
added a commit
to jgm/commonmark-hs
that referenced
this pull request
Dec 31, 2021
This follows a similar change in pandoc (jgm/pandoc#7242). Closes #84.
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Feb 11, 2022
0.2.3 * Allow bare word attribute in fenced_divs (#84). This follows a similar change in pandoc (jgm/pandoc#7242). 0.2.2.1 * Fix commonmark-extensions to build with GHC 9.2 (#81, Joseph C. Sible). Currently --allow-newer is needed. 0.2.2 * Add footnote to gfmExtensions. Note that this also requires additional type constraints on gfmExtensions [API change]. 0.2.1.2 * Fix bug with absolute paths in rebase_relative_paths extension on Windows. 0.2.1.1 * Fix bug in wikilinks extensions. 0.2.1 * Add rebase_relative_paths extension. New exported module Commonmark.Extensions.RebaseRelativePaths [API change]. * Add wikilinks_title_before_pipe and wikilinks_title_after_pipe extensions (#69). New exported module Commonmark.Extensions.Wikilinks [API change].
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.
When a block only has a single class and no other attributes, it is not necessary to wrap the class attribute in curly braces – the class name can be placed after the opening mark as is.
This will result in bit cleaner output when pandoc is used as a markdown pretty-printer.
Test