Conversation
|
Someone is attempting to deploy a commit to the Docsify Team on Vercel. A member of the Team first needs to authorize it. |
This branch has not been deployed
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.
Summary
HTML examples inside fenced or indented code blocks can disappear from the search index.
genIndex()passes their already-lexed text through the Markdown parser again, which treats tags as HTML and removes them.Keep code-token text as literal content when building the index. Other tokens retain their existing conversion, and search results still use the existing HTML escaping. Regression tests cover a code block immediately after a heading, after paragraph text, at the start of a page without a heading, and an indented code block. They also verify that the HTML example is displayed as text rather than inserted as an element.
To reproduce on a fresh page with the search plugin enabled:
Search for
customwidget. Before this change there is no result; after it, the result includes the literal<customwidget />example.Related issue, if any:
Reproduced on
developatd823dbe51c1b2dea4c2091e2b952ded0d1e16616; no matching open fix found.What kind of change does this PR introduce?
For any code change,
Does this PR introduce a breaking change?
Validation
npm run build: passed.npm run lint: passed.npm run typecheck: passed.npm run test:jest -- --runInBand: 128 tests and 46 snapshots passed.npm run test:e2e:chromium -- test/e2e/search.test.js --workers=2 --reporter=line: all 23 search-plugin tests passed.Browser coverage: Chromium via Playwright. Firefox, WebKit, and the full unrelated E2E suite were not run locally.
Developed with assistance from OpenAI Codex; the regression and fix were validated locally.