style: add Math Preprocessing for Markdown Component #335
Conversation
This file contains 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
### Add Math Preprocessing for Markdown Component
#### Summary
This PR introduces preprocessing for math expressions within the Markdown component. The component now transforms inline math (e.g., `\(...\)`) to use the `$ ... $` format and block math (e.g., `\[...\]`) to use the `$$ ... $$` format. This enhancement helps in standardizing the math syntax before it’s processed by the Markdown renderer.
#### Changes
- **Enhanced Markdown Component:**
- Added a `useMemo` hook in the `Markdown` function to preprocess the `children` content.
- **Inline Math:** Replaces `\(...\)` with `$ ... $`.
- **Block Math:** Replaces `\[...\]` with `\n$$\n ... \n$$\n`, ensuring that block math expressions are placed on separate lines.
- **Refactoring:**
- The processed content is then passed to the existing `MarkdownContent` component, preserving all existing functionalities like code highlighting, link rendering, and file block handling.
#### Rationale
Previously, the Markdown component did not handle the conversion of LaTeX-style math delimiters, which could lead to inconsistent rendering of math expressions. By preprocessing the content, we ensure a more robust and flexible handling of both inline and block math expressions.
#### Possible Drawbacks
- **Non-Mathematical Content Interference:**
The preprocessing approach targets `\(...\)` and `\[...\]` delimiters universally. This means that any non-mathematical content using these delimiters for other purposes might be unintentionally transformed, potentially leading to unexpected formatting issues.
#### How to Test
1. **Inline Math:**
- Input: `This is inline math: \(a^2 + b^2 = c^2\)`
- Expected Transformation: `This is inline math: $ a^2 + b^2 = c^2 $`
2. **Block Math:**
- Input: `Here is block math: \[ \int_0^\infty e^{-x} dx \]`
- Expected Transformation:
```
Here is block math:
$$
\int_0^\infty e^{-x} dx
$$
```
3. **Non-Mathematical Content:**
- Ensure that content not intended as math that might incidentally use these delimiters is reviewed to avoid unexpected changes.
4. **Overall Rendering:**
- Verify that the Markdown renders as expected with both math expressions and other markdown elements (e.g., code blocks, links).
#### Additional Notes
- The changes maintain backwards compatibility. If there are no math delimiters present, the content remains unaffected.
- The updated component still supports HTML rendering based on the `acceptHtml` prop.
- No changes were made to the auxiliary components (`Label`, `Link`, `Code`), ensuring that the overall markdown styling and functionalities remain consistent.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Sh1n3zZ
approved these changes
Feb 18, 2025
Sh1n3zZ
changed the title
|
Hello, We sincerely appreciate your contribution to the project and look forward to your next contribution! BEST Regards, |
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.
Add Math Preprocessing for Markdown Component
Summary
This PR introduces preprocessing for math expressions within the Markdown component. The component now transforms inline math (e.g.,
\(...\)) to use the$ ... $format and block math (e.g.,\[...\]) to use the$$ ... $$format. This enhancement helps in standardizing the math syntax before it’s processed by the Markdown renderer.Changes
useMemohook in theMarkdownfunction to preprocess thechildrencontent.\(...\)with$ ... $.\[...\]with\n$$\n ... \n$$\n, ensuring that block math expressions are placed on separate lines.MarkdownContentcomponent, preserving all existing functionalities like code highlighting, link rendering, and file block handling.Rationale
Previously, the Markdown component did not handle the conversion of LaTeX-style math delimiters wrapped in
\(...\)and\[...\], which could lead to inconsistent rendering of math expressions. By preprocessing the content, we ensure a more robust and flexible handling of both inline and block math expressions.Possible Drawbacks
\(...\)and\[...\]delimiters universally. This means that any non-mathematical content using these delimiters for other purposes might be unintentionally transformed, potentially leading to unexpected formatting issues.How to Test
This is inline math: \(a^2 + b^2 = c^2\)This is inline math: $ a^2 + b^2 = c^2 $Here is block math: \[ \int_0^\infty e^{-x} dx \]Here is block math: $$ \int_0^\infty e^{-x} dx $$Additional Notes
acceptHtmlprop.Label,Link,Code), ensuring that the overall markdown styling and functionalities remain consistent.