Fix(markdown): escape sequences for pipe characters in table cells #71

2026-10-21T12:32:05+02:00

jakob.scheid commented

2026-10-21 12:32:05 +02:00

Escape sequences for pipe characters in table cells

This pull request replaces pipe characters (|) in values of Markdown table cells with the appropriate escape sequence (\|)

There were tests which expected pipe characters in table cells to be unescaped, which is incorrect. They were updated to expect the pipe characters in values of Markdown table cells to be replaced with an escape sequence. Test cases to ensure that the new behavior works and all pipes are correctly replaced with escape sequences were added.

An entry for this fix was added to the changelog.

Motivation

Previously, pipe characters in values of Markdown table cells were not escaped. As a result, Markdown renderers which support tables split the cells containing pipe characters at those pipe characters.

Related issues

Closes #70

# Escape sequences for pipe characters in table cells This pull request replaces pipe characters (`|`) in values of Markdown table cells with the appropriate escape sequence (`\|`) There were tests which expected pipe characters in table cells to be unescaped, which is incorrect. They were updated to expect the pipe characters in values of Markdown table cells to be replaced with an escape sequence. Test cases to ensure that the new behavior works and all pipes are correctly replaced with escape sequences were added. An entry for this fix was added to the changelog. ## Motivation Previously, pipe characters in values of Markdown table cells were not escaped. As a result, Markdown renderers which support tables split the cells containing pipe characters at those pipe characters. ## Related issues Closes #70

jakob.scheid added this to the 0.2.3 milestone 2026-10-21 12:32:05 +02:00

jakob.scheid added the Kind/Bug Kind/Documentation

Priority

High

2

Kind/Testing labels 2026-10-21 12:32:05 +02:00

jakob.scheid added this to the Project Board project 2026-10-21 12:32:05 +02:00

jakob.scheid added 2 commits 2026-10-21 12:32:05 +02:00

fix(markdown): escape pipe characters in table cells a6b5e8f1c9

Pipe characters ('|') in Markdown table cells are now replaced with an
escape sequence ('\|') to ensure that cells are not split by Markdown
renderers.

Tests which expected pipe characters to be unescaped, which is
incorrect, were updatedto expect an escape sequence and new test cases
to ensure the correct escaping behavior were added.

docs(changelog): add Markdown escape sequences entry 3f74e6457e

Added a changelog entry for the escape sequences in Markdown table
cells.

jakob.scheid moved this to Review in Project Board on 2026-10-21 12:32:18 +02:00

jakob.scheid merged commit 39d3b0ace4 into main

2026-10-21 12:33:17 +02:00

jakob.scheid deleted branch fix/markdown-table-cells-pipe

2026-10-21 12:33:17 +02:00

jakob.scheid moved this to Done in Project Board on 2026-10-21 12:33:24 +02:00

Sign in to join this conversation.

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: jCloud/jcloud-docsgen#71