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.

Sign up for GitHub

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

Jump to bottom

[docs] Escape inline code block pipes in tables #10550

Merged
merged 2 commits into from Oct 5, 2020
Merged

[docs] Escape inline code block pipes in tables #10550

merged 2 commits into from Oct 5, 2020

Conversation

byCedric
Copy link
Member

@byCedric byCedric commented Oct 5, 2020 •
edited

Why

Fixes #10499
Replaces #10311, #10500

How

Because of remarkjs/remark#536, we can't escape (or use) pipes in a code block in a table. This avoids the bugged remark parser and renders it as React/HTML component so we can escape the pipe.

  • I searched with the regex below, in VSCode, to find all occurrences
\| `[^|`]+\|

Test Plan

@byCedric byCedric requested a review from barthap October 5, 2020 15:24
@byCedric byCedric merged commit f42437f into master Oct 5, 2020
@byCedric byCedric deleted the @bycedric/docs/table-pipe-fix branch October 5, 2020 15:38
barthap
barthap approved these changes Oct 5, 2020
View reviewed changes
Copy link
Contributor

@barthap barthap left a comment •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@barthap barthap barthap approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[docs] Tables which has a pipe in a code are broken
2 participants
@byCedric @barthap