[PR #23528] [CLOSED] fix: balanced display math parsing in markdown renderer #50287

New Issue

GiteaMirror · 2026-04-30T02:55:55-05:00

GiteaMirror commented

2026-04-30 02:55:55 -05:00

📋 Pull Request Information

Original PR: https://github.com/open-webui/open-webui/pull/23528
Author: @asf0
Created: 4/9/2026
Status: ❌ Closed

Base: dev ← Head: fix-latex-display-math

📝 Commits (1)

147e9fd Fix display math parsing and whitespace handling in markdown renderer

📊 Changes

3 files changed (+183 additions, -1 deletions)

View changed files

📝 src/lib/components/chat/Messages/Markdown/MarkdownInlineTokens.svelte (+1 -1)
➕ src/lib/utils/marked/katex-extension.test.ts (+115 -0)
📝 src/lib/utils/marked/katex-extension.ts (+67 -0)

📄 Description

Fixes #23526

Pull Request Checklist

Note to first-time contributors: Please open a discussion post in Discussions to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request.

This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR.

Before submitting, make sure you've checked the following:

Target branch: Verify that the pull request targets the dev branch. PRs targeting main will be immediately closed.
Description: Provide a concise description of the changes made in this pull request down below.
Changelog: Ensure a changelog entry following the format of Keep a Changelog is added at the bottom of the PR description.
Documentation: Add docs in Open WebUI Docs Repository. Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps.
Dependencies: Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash.
Testing: Perform manual tests to verify the implemented fix/feature works as intended AND does not break any other functionality. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to make screenshots of the feature/fix and include them in the PR description.
Agentic AI Code: Confirm this Pull Request is not written by any AI Agent or has at least gone through additional human review AND manual testing. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR.
Code review: Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards?
Design & Architecture: Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes.
Git Hygiene: Keep PRs atomic (one logical change). Clean up commits and rebase on dev to ensure no unrelated commits (e.g. from main) are included. Push updates to the existing PR branch instead of closing and reopening.
Title Prefix: To clearly categorize this pull request, prefix the pull request title using one of the following:
- BREAKING CHANGE: Significant changes that may affect compatibility
- build: Changes that affect the build system or external dependencies
- ci: Changes to our continuous integration processes or workflows
- chore: Refactor, cleanup, or other non-functional code changes
- docs: Documentation update or addition
- feat: Introduces a new feature or enhancement to the codebase
- fix: Bug fix or error correction
- i18n: Internationalization or localization changes
- perf: Performance improvement
- refactor: Code restructuring for better maintainability, readability, or scalability
- style: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.)
- test: Adding missing tests or correcting existing tests
- WIP: Work in progress, a temporary label for incomplete or ongoing work

Changelog Entry

Description

This PR fixes a frontend markdown/math parsing bug where balanced $$...$$ display math could render unreliably and stray $$ could interfere with message rendering.

The change is intentionally narrow:

adds balanced $$...$$ tokenization for display math
leaves unmatched $$ as plain text
preserves existing fenced ```math blocks
respects displayMode for inline-rendered math tokens when appropriate

This is a small renderer bugfix linked to the issue above.

Changelog Entry

Description

Fixes unreliable balanced $$...$$ display math parsing in the frontend markdown renderer and prevents stray $$ from disrupting message rendering.

Added

Focused frontend tests for balanced display math, multiline display math, stray delimiters, normal dollar-sign prose, punctuation-adjacent delimiters, and fenced math blocks

Changed

Narrowed the custom markdown math tokenizer to scan for balanced $$...$$ delimiters before falling back to existing regex handling
Updated inline math rendering to honor displayMode when the tokenizer marks a token as display math

Deprecated

None

Removed

None

Fixed

Balanced $$...$$ display math now renders reliably
Multiline $$ ... $$ display math is handled correctly
Stray $$ no longer breaks or destabilizes message rendering
Normal prose containing dollar signs is not aggressively transformed
Existing fenced ```math blocks continue to work

Security

Breaking Changes

None

Testing

Manual:

Open a chat in Open WebUI.
Submit prompts containing:
- $$x^2$$
- multiline $$ ... $$
- stray $$
- normal prose with dollar signs
- punctuation after closing delimiters
- fenced ```math blocks
Verify balanced display math renders, stray delimiters remain plain text, and fenced math blocks still work.

Automated:

./node_modules/.bin/vitest run src/lib/utils/marked/katex-extension.test.ts

Result:

8 tests passed

Dependencies

No new dependencies
No dependency upgrades included in this PR

Documentation

No docs update included because this is a narrow bugfix with no new user-facing settings, env vars, or public interfaces

Additional Information

Files changed:

src/lib/utils/marked/katex-extension.ts
src/lib/components/chat/Messages/Markdown/MarkdownInlineTokens.svelte
src/lib/utils/marked/katex-extension.test.ts

Screenshots or Videos

Before fix:

After fix:

Contributor License Agreement

By submitting this pull request, I confirm that I have read and fully agree to the Contributor License Agreement (CLA), and I am providing my contributions under its terms.

Note

Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/open-webui/open-webui/pull/23528 **Author:** [@asf0](https://github.com/asf0) **Created:** 4/9/2026 **Status:** ❌ Closed **Base:** `dev` ← **Head:** `fix-latex-display-math` --- ### 📝 Commits (1) - [`147e9fd`](https://github.com/open-webui/open-webui/commit/147e9fd68eb5be258ccb494e2406a109e4d37a7a) Fix display math parsing and whitespace handling in markdown renderer ### 📊 Changes **3 files changed** (+183 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `src/lib/components/chat/Messages/Markdown/MarkdownInlineTokens.svelte` (+1 -1) ➕ `src/lib/utils/marked/katex-extension.test.ts` (+115 -0) 📝 `src/lib/utils/marked/katex-extension.ts` (+67 -0) </details> ### 📄 Description Fixes #23526  # Pull Request Checklist ### Note to first-time contributors: Please open a discussion post in [Discussions](https://github.com/open-webui/open-webui/discussions) to discuss your idea/fix with the community before creating a pull request, and describe your changes before submitting a pull request. This is to ensure large feature PRs are discussed with the community first, before starting work on it. If the community does not want this feature or it is not relevant for Open WebUI as a project, it can be identified in the discussion before working on the feature and submitting the PR. **Before submitting, make sure you've checked the following:** - [x] **Target branch:** Verify that the pull request targets the `dev` branch. **PRs targeting `main` will be immediately closed.** - [x] **Description:** Provide a concise description of the changes made in this pull request down below. - [x] **Changelog:** Ensure a changelog entry following the format of [Keep a Changelog](https://keepachangelog.com/) is added at the bottom of the PR description. - [x] **Documentation:** Add docs in [Open WebUI Docs Repository](https://github.com/open-webui/docs). Document user-facing behavior, environment variables, public APIs/interfaces, or deployment steps. - [x] **Dependencies:** Are there any new or upgraded dependencies? If so, explain why, update the changelog/docs, and include any compatibility notes. Actually run the code/function that uses updated library to ensure it doesn't crash. - [x] **Testing:** Perform manual tests to **verify the implemented fix/feature works as intended AND does not break any other functionality**. Include reproducible steps to demonstrate the issue before the fix. Test edge cases (URL encoding, HTML entities, types). Take this as an opportunity to **make screenshots of the feature/fix and include them in the PR description**. - [x] **Agentic AI Code:** Confirm this Pull Request is **not written by any AI Agent** or has at least **gone through additional human review AND manual testing**. If any AI Agent is the co-author of this PR, it may lead to immediate closure of the PR. - [x] **Code review:** Have you performed a self-review of your code, addressing any coding standard issues and ensuring adherence to the project's coding standards? - [x] **Design & Architecture:** Prefer smart defaults over adding new settings; use local state for ephemeral UI logic. Open a Discussion for major architectural or UX changes. - [x] **Git Hygiene:** Keep PRs atomic (one logical change). Clean up commits and rebase on `dev` to ensure no unrelated commits (e.g. from `main`) are included. Push updates to the existing PR branch instead of closing and reopening. - [x] **Title Prefix:** To clearly categorize this pull request, prefix the pull request title using one of the following: - **BREAKING CHANGE**: Significant changes that may affect compatibility - **build**: Changes that affect the build system or external dependencies - **ci**: Changes to our continuous integration processes or workflows - **chore**: Refactor, cleanup, or other non-functional code changes - **docs**: Documentation update or addition - **feat**: Introduces a new feature or enhancement to the codebase - **fix**: Bug fix or error correction - **i18n**: Internationalization or localization changes - **perf**: Performance improvement - **refactor**: Code restructuring for better maintainability, readability, or scalability - **style**: Changes that do not affect the meaning of the code (white space, formatting, missing semi-colons, etc.) - **test**: Adding missing tests or correcting existing tests - **WIP**: Work in progress, a temporary label for incomplete or ongoing work # Changelog Entry ## Description This PR fixes a frontend markdown/math parsing bug where balanced `$$...$$` display math could render unreliably and stray `$$` could interfere with message rendering. The change is intentionally narrow: - adds balanced `$$...$$` tokenization for display math - leaves unmatched `$$` as plain text - preserves existing fenced ```math blocks - respects `displayMode` for inline-rendered math tokens when appropriate This is a small renderer bugfix linked to the issue above. ## Changelog Entry ### Description Fixes unreliable balanced `$$...$$` display math parsing in the frontend markdown renderer and prevents stray `$$` from disrupting message rendering. ### Added - Focused frontend tests for balanced display math, multiline display math, stray delimiters, normal dollar-sign prose, punctuation-adjacent delimiters, and fenced `math` blocks ### Changed - Narrowed the custom markdown math tokenizer to scan for balanced `$$...$$` delimiters before falling back to existing regex handling - Updated inline math rendering to honor `displayMode` when the tokenizer marks a token as display math ### Deprecated - None ### Removed - None ### Fixed - Balanced `$$...$$` display math now renders reliably - Multiline `$$ ... $$` display math is handled correctly - Stray `$$` no longer breaks or destabilizes message rendering - Normal prose containing dollar signs is not aggressively transformed - Existing fenced ```math blocks continue to work ### Security ### Breaking Changes - None ## Testing Manual: 1. Open a chat in Open WebUI. 2. Submit prompts containing: - `$$x^2$$` - multiline `$$ ... $$` - stray `$$` - normal prose with dollar signs - punctuation after closing delimiters - fenced ```math blocks 3. Verify balanced display math renders, stray delimiters remain plain text, and fenced math blocks still work. Automated: - `./node_modules/.bin/vitest run src/lib/utils/marked/katex-extension.test.ts` Result: - `8 tests passed` ## Dependencies - No new dependencies - No dependency upgrades included in this PR ## Documentation - No docs update included because this is a narrow bugfix with no new user-facing settings, env vars, or public interfaces ## Additional Information Files changed: - `src/lib/utils/marked/katex-extension.ts` - `src/lib/components/chat/Messages/Markdown/MarkdownInlineTokens.svelte` - `src/lib/utils/marked/katex-extension.test.ts` ### Screenshots or Videos Before fix: <img width="1230" height="1226" alt="Screenshot 2026-04-09 003501" src="https://github.com/user-attachments/assets/6cbcb10a-866d-404f-8e22-54c2d3d110ee" /> <img width="933" height="599" alt="Screenshot 2026-04-09 003520" src="https://github.com/user-attachments/assets/6e01dd04-f7c9-4b5e-9e62-21fd7bcef353" /> <img width="853" height="1140" alt="Screenshot 2026-04-09 010129" src="https://github.com/user-attachments/assets/5dabf15e-209b-42f5-a8b5-dbaa2e9f1663" /> After fix: <img width="1235" height="1160" alt="Screenshot 2026-04-09 003401" src="https://github.com/user-attachments/assets/07a31894-ccf3-4ff1-8154-26324c6bc92e" /> <img width="873" height="507" alt="Screenshot 2026-04-09 003420" src="https://github.com/user-attachments/assets/86a12e72-d5e7-4864-a887-40cd3c50263b" /> <img width="1030" height="787" alt="Screenshot 2026-04-09 010211" src="https://github.com/user-attachments/assets/86cc930e-e9d8-42c6-a904-cfc5ab0518ed" /> ### Contributor License Agreement  - [x] By submitting this pull request, I confirm that I have read and fully agree to the [Contributor License Agreement (CLA)](https://github.com/open-webui/open-webui/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT), and I am providing my contributions under its terms. > [!NOTE] > Deleting the CLA section will lead to immediate closure of your PR and it will not be merged in. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

GiteaMirror added the pull-request label 2026-04-30 02:55:55 -05:00

GiteaMirror closed this issue

2026-04-30 02:56:01 -05:00

Sign in to join this conversation.

Branches Tags

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: github-starred/open-webui#50287