Turn off markdown linting rule for code blocks #2225
Conversation
Our style guide says that we want three backticks for code blocks, but to prefer (where possible) four tildes for special blocks like the exercism/caution block or exercism/note block. The linter we use provides three options for linting: - only backticks - only tildes - be consistent within a file None of these options work for us, so we're turning off this linting rule.
kytrinyx
force-pushed
the
markdown-codeblocks-linting
branch
from
8822b00 to
1aeb6d3
Compare
iHiD
changed the title
|
I was going to bring this in, but there is another potential. I believe we can use tilde, "~", or back tick, "`", for code blocks. We could document to use 3 of one and 3 of the other for specific semantics. |
|
@kotp we can use either tilde or backticks for code blocks, but we would prefer to use backticks for code blocks and tildes for caution blocks. |
|
Right on. I get that. I was not very clear, is the problem the count of 4 in the one use. Is it complaining about the use of 3 and 4 marks (seemingly inconsistent use), rather than taking advantage of our preferred use of backtick for one purpose and tilde for another? |
|
To clarify, it does have the option of "be consistent" and so if we consistently used 3 instead of 3 and 4, then would that be enough consistency? |
|
@kotp it's possible; I haven't tested it. We want 3 backticks and 4 tildes. I don't want to change our preference, I just want CI to let us do what we want. |
4 participants
Our style guide says that we want three backticks for code blocks, but to prefer (where possible) four tildes for special blocks like the exercism/caution block or exercism/note block.
The linter we use provides three options for linting:
None of these options work for us, so we're turning off this linting rule.