RoRvsWild Ruby Documentation Theme

https://www.rorvswild.com/blog/2024/rorvswild-rdoc-theme

by thunderbong • 2 years ago

38 9 2 years ago

Are we going to have another discussion how according to HN the most important requirement for a programming language documentation site is not met -- it is not mobile first?

striking• 2 years ago

I mean, you can test it for yourself here, it's responsive: https://basesecrete.github.io/rorvswild-theme-rdoc/BasicSock...

I couldn't find a way to force the table of contents drawer out from the right side of the screen when the screen is too narrow to show it by default, but otherwise it looks pretty good to me?

And it is important, isn't it? Not everyone has a second monitor attached all the time, sometimes you do want to look things up on your phone.

8s2ngy• 2 years ago

At first glance, this looks really impressive!

cdiamand• 2 years ago

This looks great. Nice job!

Mystery-Machine• 2 years ago

This is the Ruby documentation site that I use that has really beautiful design! https://rubyapi.org/

I'd love to see these two projects merged together: https://rubyapi.org/ and https://basesecrete.github.io/rorvswild-theme-rdoc/

mrinterweb2• 2 years ago

Love it. Rdoc's styles have felt quite dated for years. Compared with other languages, rdoc hasn't really been keeping up with style. Really appreciate the effort to improve rdoc's styling.

ceritium• 2 years ago

Congrats, it looks charming. As a suggestion, it would be great if the sidebar text was larger on mobile.

mrinterweb2• 2 years ago

I haven't found a way to get this template to work with `yard server --gems`. The yard server is such a powerful local development tool. I find having local documentation for the version of the gems in your Gemfile.lock is so useful.

Lio• 2 years ago

Another vote for this. Great work thanks.

RoRvsWild Ruby Documentation Theme

Related Stories