New theme?

[antoinem]

Hello,

We’ve started a new theme derived from Darkfish.
You can see how it looks here:
https://basesecrete.github.io/rdoc/

As you can see, there are already quite a few changes (navigation, typography, colors, dark mode…).
We wanted to check if there was some interest, before we spend more time on it.

What do you think?

Cheers,
Antoine and Alexis

[st0012]

Thank you for proposing this 🙌
I'm open to accept new optional themes and here's my thought on this topic:

• To encourage more usage on this tool and documentation writing in Ruby in general, more theme options are needed (2~3 in rdoc may be the best?)
• While whether rdoc maintainers will be able to maintain them long-term is surely a concern, I think it's a risk we need to take to grow the community. It can also be mitigated a bit through clear communication (e.g. we'll do our best but only the default theme is officially supported)

WDYT? @colby-swandale

A few notes to this PR:

• Please submit document changes (e.g. update heading) in a separate PR
• The addition of super_classes should be extracted too
• Since it's a new theme, I think it's better to remove some references to darkfish like "Darkfish" Rdoc CSS.
• I'm not familiar with js best practices, but my understanding is that darkfish.js unlikely to follow much of them. So I'd love to see new theme implementations not following its pattern unless necessary. I know it may be already on your roadmap, but I want to explicitly point it out.

[alexisbernard]

Thanks for the feedback. I have extracted super_classes into its own PR.

I'm not familiar with js best practices, but my understanding is that darkfish.js unlikely to follow much of them. So I'd love to see new theme implementations not following its pattern unless necessary. I know it may be already on your roadmap, but I want to explicitly point it out.

We don't have specific plan for the JS. I think the less JS it contains, the better it is. We only added few lines of JS compared to Darkfish. Otherwise it could share the JS with Darkfish, but it would be more fragile.