Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modernize RDoc Darkfish template CSS #1157

Merged
merged 1 commit into from
Aug 24, 2024
Merged

Modernize RDoc Darkfish template CSS #1157

merged 1 commit into from
Aug 24, 2024

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Aug 19, 2024

  • Update color scheme with muted green tones and improved contrast
  • Enhance readability by adjusting font sizes and weights
  • Improve code block styling with a light gray background
  • Refactor layout for better responsiveness and sidebar presentation
  • Standardize link styles across the document
  • Implement CSS variables for easier theme customization
  • Adjust heading styles for better visual hierarchy
  • Enhance table and list styling for improved readability
  • Optimize search field and navigation toggle appearance
  • Improve method detail and documentation section styling
  • Reorganize css and overhaul the sidebar design
  • Improve code block's syntax highlighting

Result

rdoc-theme-demo.mp4

Comparisions

For detail comparison, I recommend clicking into images.

Left: old; Right: new

RDoc

rdoc-diff-3 rdoc-diff-4 rdoc-diff-2 rdoc-diff-1

Ruby official docs

ruby-diff-2 ruby-diff-1

@st0012
Copy link
Member Author

st0012 commented Aug 19, 2024

@paracycle Thanks for the suggestions. I've extracted fonts into variables as well as cleaned up some variable usages.

- Update color scheme with muted green tones and improved contrast
- Enhance readability by adjusting font sizes and weights
- Improve code block styling with a light gray background
- Refactor layout for better responsiveness and sidebar presentation
- Standardize link styles across the document
- Implement CSS variables for easier theme customization
- Adjust heading styles for better visual hierarchy
- Enhance table and list styling for improved readability
- Optimize search field and navigation toggle appearance
- Improve method detail and documentation section styling
- Reorganize css and overhaul the sidebar design
- Improve code block's syntax highlighting
@st0012 st0012 merged commit 6cde9ed into master Aug 24, 2024
51 checks passed
@st0012 st0012 deleted the improve-styling branch August 24, 2024 11:07
matzbot pushed a commit to ruby/ruby that referenced this pull request Aug 24, 2024
(ruby/rdoc#1157)

- Update color scheme with muted green tones and improved contrast
- Enhance readability by adjusting font sizes and weights
- Improve code block styling with a light gray background
- Refactor layout for better responsiveness and sidebar presentation
- Standardize link styles across the document
- Implement CSS variables for easier theme customization
- Adjust heading styles for better visual hierarchy
- Enhance table and list styling for improved readability
- Optimize search field and navigation toggle appearance
- Improve method detail and documentation section styling
- Reorganize css and overhaul the sidebar design
- Improve code block's syntax highlighting

ruby/rdoc@6cde9edadb
@MatheusRich
Copy link
Contributor

@st0012 TY for the update! I notices that some pages (here's an example) are hard to read on mobile.

@st0012
Copy link
Member Author

st0012 commented Aug 24, 2024

Do you mean because of the initial zoom?

@MatheusRich
Copy link
Contributor

Yeah. Users shouldn't need to zoom in/out to read on mobile. It's like the text doesn't wrap or something. I'm AFK so I can't tell exactly what's going on

@st0012
Copy link
Member Author

st0012 commented Aug 24, 2024

#1162

@st0012 st0012 added this to the v6.8.0 milestone Oct 19, 2024
Comment on lines +240 to +241
nav ul li details > summary {
list-style: none; /* Remove the default marker */
Copy link
Member

Choose a reason for hiding this comment

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

Unfortunately, this still doesn't work in Safari 18.1.
summary::-webkit-details-marker {display: none;} is needed.

@nevans
Copy link
Contributor

nevans commented Nov 5, 2024

  • Enhance table and list styling for improved readability

Was it intentional to make label lists and note lists render the exact same way? IMO, it's useful to have the two different definition list styles, even though I'd love for one or both of them to be slightly different from what they are in 6.7.0.

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

Successfully merging this pull request may close these issues.

6 participants