Skip to content

New theme: "Aliki"#1432

Merged
st0012 merged 5 commits into
masterfrom
aliki
Nov 15, 2025
Merged

New theme: "Aliki"#1432
st0012 merged 5 commits into
masterfrom
aliki

Conversation

@st0012

@st0012 st0012 commented Oct 12, 2025

Copy link
Copy Markdown
Member

This theme's "backend" (Ruby part) is mostly based on Darkfish. But design and frontend features is (IMO) a lot better than it.

The work was assisted by AI coding tools through a few weeks. I cleaned up the history because they're not helping reviewing anyway.

(Aliki is the name of my cat, which was not involved in this work)

Key features

  • 3 column design (which matches most API docs nowadays)
  • Switchable dark mode
  • Right ToC column
  • Better search UI
  • Slightly better mobile design
  • Code pasting support

Future work

  • Configurable top navbar items (at least link to GH and gem?)
  • Configurable footer (same as the above?)
  • Social media preview image support (it's not possible have nice static preview cards without an image)
  • ???

Preview

Link in #1432 (comment)

@matzbot

matzbot commented Oct 12, 2025

Copy link
Copy Markdown
Collaborator

🚀 Preview deployment available at: https://8a331ebe.rdoc-6cd.pages.dev (commit: 732c549)

@st0012 st0012 force-pushed the aliki branch 6 times, most recently from 895f159 to 5771f3e Compare October 31, 2025 14:11
@st0012 st0012 marked this pull request as ready for review October 31, 2025 14:19
@st0012 st0012 force-pushed the aliki branch 2 times, most recently from c1678e0 to d8340db Compare November 9, 2025 15:25
@hsbt

hsbt commented Nov 10, 2025

Copy link
Copy Markdown
Member

I prefer Aliki theme. I'm +1 to make this theme as default.

@colby-swandale

Copy link
Copy Markdown
Member

Same!

@kou

kou commented Nov 10, 2025

Copy link
Copy Markdown
Member

+1

@mame

mame commented Nov 11, 2025

Copy link
Copy Markdown
Member

Does this URL stay the same? If existing links, including fragments, continue to work well, it looks good 👍

@st0012

st0012 commented Nov 11, 2025

Copy link
Copy Markdown
Member Author

@mame Thanks. And yes, the theme should not change any RDoc behaviour other than the visuals.

@nobu

nobu commented Nov 13, 2025

Copy link
Copy Markdown
Member

I think it's better to make the blue letters in dark mode a little brighter.
In general, less contrast combination does not look good.

@tompng tompng left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

👍

@st0012 st0012 force-pushed the aliki branch 5 times, most recently from 53b048c to 4741b69 Compare November 15, 2025 15:21
@st0012 st0012 force-pushed the aliki branch 2 times, most recently from 46420a7 to 84e08ae Compare November 15, 2025 15:36
@st0012

st0012 commented Nov 15, 2025

Copy link
Copy Markdown
Member Author

@nobu I've updated the blue color in the dark mode so it has more contrast with the background. Let me know if it works, I'd also be happy to open/accept follow up PRs to improve it.

@st0012 st0012 merged commit d6573b3 into master Nov 15, 2025
62 checks passed
@st0012 st0012 deleted the aliki branch November 15, 2025 16:00
@rmosolgo

rmosolgo commented Dec 4, 2025

Copy link
Copy Markdown

👋 I just noticed this new theme on the Ruby docs website. It is really nice, thank you for working on it!

@st0012

st0012 commented Dec 4, 2025

Copy link
Copy Markdown
Member Author

@rmosolgo Thank you for the kind words. I really appreciate it 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

9 participants