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: make sidebar menu medium font weight #1853

Merged
merged 3 commits into from
Jan 11, 2025
Merged

feat: make sidebar menu medium font weight #1853

merged 3 commits into from
Jan 11, 2025

Conversation

jcstein
Copy link
Member

@jcstein jcstein commented Jan 9, 2025

Overview

Modifies the font weight on sidebar, making it look less bold.
Update:
Screenshot 2025-01-09 at 13 31 38

Original:
image

Summary by CodeRabbit

  • Style
    • Updated sidebar item styling with consistent font family and weight across different levels
    • Enhanced active sidebar item appearance with brand color text

@jcstein jcstein requested a review from lukecd January 9, 2025 18:33
@jcstein jcstein self-assigned this Jan 9, 2025
Copy link
Contributor

coderabbitai bot commented Jan 9, 2025

Walkthrough

The pull request introduces new CSS rules for the .VPSidebar class and its nested elements in the VitePress theme. It sets the font family for the sidebar and its items to var(--font-body) with high precedence, while also defining font weights and colors for active items. These changes aim to improve the styling consistency and visual appeal of the sidebar components.

Changes

File Change Summary
.vitepress/theme/style.css Added CSS rules for .VPSidebar and related classes:
- Set font family to var(--font-body) with !important for .VPSidebar
- Defined font family and weight for .VPSidebarItem .text, .VPSidebarGroup .title, .VPSidebarGroup .items, .VPSidebarGroup .VPLink, .VPDocAsideOutline .outline-title, and .VPDocAsideOutline .outline-link
- Changed text color to brand color for active sidebar items with .VPSidebarItem.is-active .text

Possibly related PRs

Poem

🐰 In the sidebar, fonts align,
With colors bright, they surely shine.
Active items, bold and true,
A rabbit's touch, just for you!
Style and grace in every line,
VitePress shines, oh how divine! 🎨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f66adfc and a081257.

📒 Files selected for processing (1)
  • .vitepress/theme/style.css (1 hunks)
🔇 Additional comments (3)
.vitepress/theme/style.css (3)

162-164: LGTM: Font family consistency established

The font family is correctly set to use Untitled-Sans consistently across the sidebar.


166-174: Align font weight with PR objective and design feedback

The current implementation uses normal weight (400), but there's been discussion about using different weights:

  • Medium (500) was suggested to match PR objective
  • Light (300) was suggested in feedback

Since the PR objective specifically mentions "medium font weight" and Untitled-Sans is available in medium weight (500), consider updating the weight:

  font-family: var(--font-body) !important;
-  font-weight: 400 !important;
+  font-weight: 500 !important;

176-178: LGTM: Proper active state highlighting

The active state is correctly highlighted using the brand color variable, providing clear visual feedback.


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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
Contributor

github-actions bot commented Jan 9, 2025

PR Preview Action v1.5.0
🚀 Deployed preview to https://celestiaorg.github.io/docs-preview/pr-1853/
on branch main at 2025-01-10 15:41 UTC

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: 1

🧹 Nitpick comments (1)
.vitepress/theme/style.css (1)

162-166: Consider alternative to !important if possible

While !important works here, it's generally better to avoid it if possible. Consider increasing selector specificity instead:

-.VPSidebarItem.level-1 .text,
-.VPSidebarItem.level-2 .text,
-.VPSidebarItem.level-3 .text {
-  font-weight: 500 !important;
+.vp-doc .VPSidebarItem.level-1 .text,
+.vp-doc .VPSidebarItem.level-2 .text,
+.vp-doc .VPSidebarItem.level-3 .text {
+  font-weight: 500;
 }

However, if this doesn't override the framework styles, keeping !important is acceptable for theme customization.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a089fbc and fba70c6.

📒 Files selected for processing (1)
  • .vitepress/theme/style.css (1 hunks)
🔇 Additional comments (1)
.vitepress/theme/style.css (1)

168-170: LGTM! Good use of CSS variables

The implementation correctly uses the brand color variable for active sidebar items, maintaining consistency with the theme's color system.

.vitepress/theme/style.css Outdated Show resolved Hide resolved
.vitepress/theme/style.css Outdated Show resolved Hide resolved
@jcstein jcstein enabled auto-merge (squash) January 10, 2025 01:47
@jcstein jcstein disabled auto-merge January 10, 2025 01:48
@jcstein
Copy link
Member Author

jcstein commented Jan 10, 2025

While reviewing with Luke and looking at another example, it looks like the thing that was off with this was the font not being the same throughout the sidebar.
Screenshot 2025-01-09 at 20 58 16
Screenshot 2025-01-09 at 20 58 13

@jcstein jcstein merged commit 6950ae3 into main Jan 11, 2025
6 checks passed
@jcstein jcstein deleted the jcs/styling-update branch January 11, 2025 00:06
jcstein added a commit that referenced this pull request Jan 11, 2025
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.

None yet

1 participant