{{ message }}
docs: explain escaping pipes in tables - #7079
Merged
Merged
Conversation
ethanpalm
approved these changes
Aug 25, 2026
ethanpalm
left a comment
ethanpalm
left a comment
Collaborator
There was a problem hiding this comment.
Thanks for creating this PR, @hamedrabah! Appreciate you taking the time to update the Mintlify docs and the well written description of the problem
This was referenced Aug 25, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Documentation changes
Adds an Escape pipe characters section to the tables guide. It explains that literal pipe characters in table cells must be escaped, including pipes inside inline code, and provides both a rendered example and its MDX source.
Related to #2749. This documentation change does not modify CLI diagnostics; it documents one reproducible cause of parsing errors and the correct workaround.
For Reviewers
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience
Validation
mint validate --telemetry=falseread\|writein the source renders asread|writeNote
Low Risk
Documentation-only update to a single MDX page with no runtime or tooling changes.
Overview
Adds an Escape pipe characters subsection to the lists-and-tables guide (
create/list-table.mdx), placed before column alignment.It documents that literal
|in table cells must be written as\|, including inside inline code, because unescaped pipes are parsed as column separators and can break preview or validation. The section includes a live example (read\|write) and matching MDX source block.This is documentation only (related to #2749); no CLI or parser behavior changes.
Reviewed by Cursor Bugbot for commit 8853dc4. Bugbot is set up for automated code reviews on this repo. Configure here.