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

fix(docs): show wrong image in light theme #230

Merged
merged 1 commit into from
Sep 25, 2024
Merged

fix(docs): show wrong image in light theme #230

merged 1 commit into from
Sep 25, 2024

Conversation

withden
Copy link
Contributor

@withden withden commented Sep 25, 2024

Hi reviewer,

I see the issue, both images are showing on light theme mode. I changed the CSS to show specific images in dark and light modes at: https://velite.js.org/guide/introduction

Previous Behaviour:

image

After:

image

Summary by CodeRabbit

  • New Features

    • Enhanced documentation theme to conditionally hide images intended for dark mode when viewed in light mode.
  • Bug Fixes

    • Clarified CSS rules for improved visibility of images based on the current theme.

Copy link

coderabbitai bot commented Sep 25, 2024

Walkthrough

The changes involve modifications to the CSS rules governing the display of images in the documentation theme. A new rule is added to hide images that have a source ending in #dark when the HTML element lacks the class dark. This ensures that these images are not visible in light mode, while the existing rule that also hides them remains intact.

Changes

File Change Summary
docs/.vitepress/theme/custom.css Introduced a new CSS rule to hide images with a source ending in #dark when the HTML element does not have the class dark. The previous rule for hiding these images remains unchanged.

Poem

In the light, the dark images hide,
A CSS change, a theme's gentle guide.
With rules in place, the vision is clear,
Only the right images will appear!
Hopping along, we celebrate this feat,
A documentation theme that's truly neat! 🐇✨


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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

@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

🧹 Outside diff range and nitpick comments (1)
docs/.vitepress/theme/custom.css (1)

23-25: LGTM! Consider a minor adjustment for consistency.

The new CSS rule effectively addresses the issue of incorrect image display in light theme mode, as mentioned in the PR objectives. It ensures that images intended for dark mode (with src ending in '#dark') are not displayed when the page is in light mode.

For consistency with the existing dark mode rule, consider adding the '.vp-doc' class selector:

-html:not(.dark) .vp-doc img[src$='#dark']{
+html:not(.dark) .vp-doc img[src$='#dark'] {
   display: none;
 }

This change makes the selector more specific and aligns it with the existing dark mode rule, potentially preventing conflicts with other styles in the future.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between fcb2d32 and 84b0653.

📒 Files selected for processing (1)
  • docs/.vitepress/theme/custom.css (1 hunks)

Copy link
Owner

@zce zce left a comment

Choose a reason for hiding this comment

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

Thanks 👍

@zce zce merged commit e56c5d4 into zce:main Sep 25, 2024
2 checks passed
@withden withden deleted the patch-1 branch September 26, 2024 03:25
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