Fix markdown escape pipe character in table cell #813
Merged
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.
There is some disagreement between Markdown parsers about escaping pipe characters (
|
) inside a table cell. Python-markdown, which is used by our site generator mkdocs, considers a pipe inside a code span as escaped (`|`
) (Python-Markdown/markdown#436). Most other Markdown parsers, including ones used in tooling (such as markdownlint) require explicit escaping (`\|`
). Python-markdown would render the backslash:This is a known interoperability issue based on different implementations of a Markdown parser (mkdocs/mkdocs#2761). There's no expectation for this to get fixed somewhow, so we can only apply a workaround to use code that different parsers agree upon: This patch replaces backticks with HTML
<code>
tags, for which all parsers require escaping the pipe character.