Skip to content

docs: switch sphinx theme to shibuya#4433

Open
hwhsu1231 wants to merge 1 commit into
highlightjs:mainfrom
hwhsu1231-fork:shibuya-theme
Open

docs: switch sphinx theme to shibuya#4433
hwhsu1231 wants to merge 1 commit into
highlightjs:mainfrom
hwhsu1231-fork:shibuya-theme

Conversation

@hwhsu1231

Copy link
Copy Markdown
Contributor

Changes

Switch sphinx theme to shibuya.

Checklist

  • Added markup tests, or they don't apply here because...
  • Updated the changelog at CHANGES.md

@github-actions

github-actions Bot commented Jul 7, 2026

Copy link
Copy Markdown

Build Size Report

Changes to minified artifacts in /build, after gzip compression.

3 files changed

Total change -3 B

View Changes
file base pr diff
es/core.min.js 8.19 KB 8.19 KB -1 B
es/highlight.min.js 8.19 KB 8.19 KB -1 B
highlight.min.js 8.23 KB 8.23 KB -1 B

@joshgoebel

Copy link
Copy Markdown
Member

Please attach the screen snaps of what it would look like.

@hwhsu1231

Copy link
Copy Markdown
Contributor Author

Please attach the screen snaps of what it would look like.

Sure. The following are the screenshots in dark and light modes:

Screenshot_20260706_025656 Screenshot_20260706_025706

@joshgoebel

joshgoebel commented Jul 8, 2026

Copy link
Copy Markdown
Member

Docs for the theme: https://shibuya.lepture.com/writing/lists/

@allejo any thoughts here? I didn't really have any issues with the existing docs, but...

@arturict

Copy link
Copy Markdown
Contributor

Small suggestion: if this docs theme change is purely visual, could you mention expected rendering impact or rollback path in the description for easier review?

@hwhsu1231

Copy link
Copy Markdown
Contributor Author

@arturict The main reason I suggested switching the Sphinx theme from RTD to Shibuya (as mentioned in #4420) comes down to two key design features: "dark mode" and the "three-column layout":

Finally, I plan to submit a new PR later to migrate the current highlight.js documentation theme from sphinx-rtd-theme to shibuya, which offers a built-in "dark mode", and its "three-column layout" (global TOC, page content, local TOC) aligns perfectly with modern theme trends. Below is a preview of what it looks like after migrating to Shibuya:

@joshgoebel

Copy link
Copy Markdown
Member

I'll let @allejo decide this one. I'm not sure a dark theme is critical and I don't often change things just because they are newer/shinier... when who knows what problems come with new things... but this seems ok... just waiting for allejo to weigh in.

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.

3 participants