Skip to content

fix: neutral inline code color and github-dark syntax theme for readability#479

Merged
vihar merged 1 commit into
masterfrom
fix/dark-mode-code-readability
Jul 23, 2026
Merged

fix: neutral inline code color and github-dark syntax theme for readability#479
vihar merged 1 commit into
masterfrom
fix/dark-mode-code-readability

Conversation

@vihar

@vihar vihar commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Problem

Inline code inherits the brand color via VitePress's default --vp-code-color: var(--vp-c-brand-1), so every inline code span renders in Plane blue on a gray pill — hard to read, especially in dark mode. Dark code blocks also used the dracula syntax theme, whose palette assumes a #282a36 background, but our blocks sit on near-black #0f0f0f, washing out comments and muted tokens.

Before
CleanShot 2026-07-23 at 20 31 25@2x

After
CleanShot 2026-07-23 at 20 30 57@2x

Changes

  • style.css: override --vp-code-color to var(--vp-c-text-1) so inline code uses the neutral body-text color in both modes (GitHub-style — monospace + pill background signal code, not color). Code inside links keeps brand blue via --vp-code-link-color.
  • config.ts: swap the dark syntax theme draculagithub-dark, designed for dark backgrounds.

Verification

  • Served the production build and checked code-heavy pages (PQL reference, Plane Runner) in both modes: inline code is now high-contrast neutral pills; TypeScript blocks show clearly legible keywords/types/comments; light mode unchanged.
  • pnpm check:format and pnpm build pass.

Companion PR in developer-docs applies the same treatment for consistency.

Summary by CodeRabbit

  • Style
    • Updated the documentation’s dark theme to GitHub Dark.
    • Improved inline code readability by using neutral text coloring across light and dark modes.

@vercel

vercel Bot commented Jul 23, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jul 23, 2026 3:01pm

Request Review

@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

VitePress now uses the GitHub Dark Markdown theme, and inline code styling uses the standard text color variable across the theme modes.

Changes

VitePress theme updates

Layer / File(s) Summary
Theme configuration and code styling
docs/.vitepress/config.ts, docs/.vitepress/theme/style.css
The dark Markdown theme changes from dracula to github-dark, and --vp-code-color is set to --vp-c-text-1.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • makeplane/docs#436: Updates the VitePress site theme and overlaps with the same configuration and styling files.

Suggested reviewers: srinivaspendem

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly matches the main changes: neutral inline code color and switching the dark syntax theme to github-dark.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/dark-mode-code-readability

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@vihar
vihar merged commit f3804cb into master Jul 23, 2026
5 checks passed
@vihar
vihar deleted the fix/dark-mode-code-readability branch July 23, 2026 15:16
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