fix(visual): truncate headings, escape HTML in orama#460
Merged
avivkeller merged 5 commits intomainfrom Oct 16, 2025
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR fixes visual issues in the documentation by escaping HTML characters in Orama search results and preventing heading overflow with ellipsis truncation.
- Adds HTML entity escaping for
<and>characters to prevent Orama from interpreting them as HTML - Implements CSS truncation for long headings in the documentation UI
- Updates
transformNodeToStringandtransformNodesToStringfunctions to support optional HTML entity escaping
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| src/utils/unist.mjs | Added escapeHTMLEntities function and optional escape parameter to node transformation functions |
| src/generators/web/ui/index.css | Added CSS rules to truncate headings with ellipsis and prevent overflow |
| src/generators/orama-db/index.mjs | Updated to pass true for HTML entity escaping when generating Orama descriptions |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #460 +/- ##
==========================================
- Coverage 74.55% 74.54% -0.01%
==========================================
Files 107 107
Lines 10466 10479 +13
Branches 684 686 +2
==========================================
+ Hits 7803 7812 +9
- Misses 2661 2664 +3
- Partials 2 3 +1 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
flakey5
approved these changes
Oct 12, 2025
ovflowd
reviewed
Oct 12, 2025
ovflowd
approved these changes
Oct 12, 2025
canerakdas
approved these changes
Oct 12, 2025
AugustinMauroy
approved these changes
Oct 12, 2025
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
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.
Ref: #455
This PR:
<and>on theorama-dbgenerator, as Orama interprets them as HTML