Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ feat(markdown): 对纯文本的代码块内容进行折行处理 #5136

Merged
merged 1 commit into from
Aug 2, 2024

Conversation

frostime
Copy link
Contributor

@frostime frostime commented Jul 29, 2024

💻 变更类型 | Change Type

  • feat
  • fix
  • refactor
  • perf
  • style
  • test
  • docs
  • ci
  • chore
  • build

🔀 变更说明 | Description of Change

当代码块的类型为可阅读纯文本(如 md、text、tex)的时候,保留代码块中的折行,使得阅读更加方便。

效果如下,在这个案例中,如果代码块为 md 类型,则折行显示,可以看到其显示效果优于不折行。

image

📝 补充信息 | Additional Information

Nothing else.

Summary by CodeRabbit

  • New Features

    • Improved rendering of code blocks in markdown content, ensuring proper text wrapping based on language type.
  • Bug Fixes

    • Enhanced visual presentation of code snippets, resolving issues with text formatting in certain languages.

Copy link

vercel bot commented Jul 29, 2024

@frostime is attempting to deploy a commit to the NextChat Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Jul 29, 2024

Walkthrough

The recent changes introduce a useEffect hook to the PreCode component, enhancing how code blocks are rendered in markdown. By applying specific styles to code elements based on their language class, the updates improve text formatting and overall user experience. This ensures that code snippets are visually appealing and easier to read, adapting their presentation dynamically when the component mounts.

Changes

Files Change Summary
app/components/markdown.tsx Added useEffect hook in PreCode to apply whiteSpace: "pre-wrap" style to specific <code> elements based on class names.

Poem

🐇 In a garden of code, where the snippets play,
A sprinkle of style brightens the day.
With a wrap and a twirl, they dance on the screen,
Making text flow like a soft, gentle stream.
Hooray for the changes, let joy take flight,
In the world of markdown, everything's bright! 🌟


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 90e1fad and d49ecec.

Files selected for processing (1)
  • app/components/markdown.tsx (1 hunks)
Additional comments not posted (1)
app/components/markdown.tsx (1)

99-123: Ensure correctness and performance of DOM manipulation.

The useEffect hook correctly identifies and applies styles to <code> elements based on their language class. However, consider the following:

  1. Correctness: Ensure that the wrapLanguages array covers all necessary languages and that the CSS style is correctly applied.
  2. Performance: Querying and manipulating the DOM can be expensive. Ensure this does not significantly impact performance, especially with large documents.

Overall, the changes look good and should enhance readability for the specified languages.

Copy link
Contributor

Your build has completed!

Preview deployment

@frostime
Copy link
Contributor Author

Bot 报错

Vercel — Authorization required to deploy.

我需要做些什么吗?

@lloydzhou lloydzhou requested a review from Dogtiti August 2, 2024 10:53
@lloydzhou lloydzhou merged commit 324d30b into ChatGPTNextWeb:main Aug 2, 2024
1 of 2 checks passed
@coderabbitai coderabbitai bot mentioned this pull request Nov 12, 2024
10 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants