fix: escape asterisks in multi-vector-embeddings.md #3043
Merged
Conversation
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
docusaurus seems to treat `*` as meta characters for italicizing text and so the formulas become mangled. Escaping them like so \* seems to do the trick. Tested in a Docusaurus Playground (navigate to tutorial/intro.md): https://codesandbox.io/p/devbox/wild-dust-ltgrg3?workspaceId=ws_7ZwZBX3vvx2Q2XvrF5z9ud
![orca-security-eu[bot]](https://avatars.githubusercontent.com/in/276244?s=60&v=4){kind=small}
There was a problem hiding this comment.
Orca Security Scan Summary
| Status | Check | Issues by priority | |
|---|---|---|---|
 Passed |
Infrastructure as Code |  0  0  0  0 |
View in Orca |
| Passed |
SAST | 0 0 0 0 |
View in Orca |
| Passed |
Secrets | 0 0 0 0 |
View in Orca |
| Passed |
Vulnerabilities | 0 0 0 0 |
View in Orca |
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.
See the last sentence of the paragraph detailing how to estimate the size of a multi-vector embedding:
This happens in both Chrome and Safari.
What's being changed:
docusaurus seems to treat
*as a meta character for italicizing text regardless of its positioning, so some formulas become mangled.Escaping them like so
\*seems to do the trick.Type of change:
How Has This Been Tested?
Tested in a Docusaurus Playground:
>icon), rundevtask, and Open Preview(sorry, I still haven't tried running this locally, just wanted to leave this PR as a note about sth I noticed)
yarn start