ruby
Add support for mobile screen sizes on Darkfish
This adds support for reading the Darkfish-generated docs in mobile devices. I tried to keep the changes minimal, and the current layout was mostly preserved.
The most notable change is the navigation sidebar, which is now hidden by default on "small screens" (everything below 1024px). It can be toggled by the button on the top left corner. This button implements the ARIA pattern for a disclosure widget. The icon for the button was taken from Iconoir, which is licensed under the MIT license.
The design and some of the implementation were loosely inspired by the Elixir lang docs.
Screenshots
General look (before/after)
Code blocks (before/after)
Desktop view (before/after)
The most notable change here is that I limited the content size to about 1000px. Long lines are hard to read, so I added this little quality-of-life improvement for desktop users.
The sidebar can also be closed on desktop:
Video
https://github.com/ruby/rdoc/assets/20938712/0aabe07f-4c9e-409f-8e28-2222881320ea
Testing
I wasn't sure if this change required tests. LMK if I need to add them.
Thank you, seems very nice. Just one concern, when resizing the navigation pane, the menu icon doesn't move.
when resizing the navigation pane, the menu icon doesn't move.
@nobu, I totally missed that it is resizable! Would it be a problem if we make it fixed-sized? I think that would be a small sacrifice for a simpler solution.
Edit: I made the sidebar fixed-sized.
@nobu could you approve the workflow so we can see if this works on CI? Thank you!
It looks like the tests breaking here are the same as the ones in the main branch.
