Commit 0042785
authored
Polish Aliki documentation theme (ruby#1742)
## Problem
The Aliki HTML theme has several small visual inconsistencies that add
up when browsing generated documentation: method cards and source
toggles compete for attention, selected and nested navigation states
create uneven spacing, page titles do not clearly distinguish object
kind from object name, section dividers are visually heavy, the footer
can sit awkwardly against the sidebar at narrower desktop widths, and
the desktop search field is not aligned with the main reading column.
These issues make the default generated docs feel less polished than the
underlying content warrants, especially on method-heavy pages and wide
layouts with both side navigation and the table of contents visible.
## Solution
- Add a DESIGN.md contract for the Aliki theme so spacing, color,
navigation, method-card, search, title, and footer decisions are
documented in one place.
- Refine method cards, source controls, borders, and section dividers so
code-object pages read with clearer hierarchy and less visual noise.
- Clarify generated navigation structure by giving the left sidebar and
right table of contents distinct IDs and matching selector names.
- Improve page-title kind labeling, nested sidebar spacing, and footer
behavior across desktop breakpoints.
- Align the desktop search field and dropdown to the main content rail
while preserving the existing mobile search modal behavior.
## Screenshots
### Before
<img width="1181" height="713" alt="Screenshot 2026-06-24 at 15 55 34"
src="https://github.com/user-attachments/assets/50f5aea8-b32d-4223-91a4-2ff0a6b3d0c7"
/>
---
<img width="785" height="409" alt="Screenshot 2026-06-24 at 15 56 45"
src="https://github.com/user-attachments/assets/db1780a6-5de8-4123-9edc-7394629c05e3"
/>
### After
<img width="1182" height="761" alt="Screenshot 2026-06-24 at 15 56 06"
src="https://github.com/user-attachments/assets/c238fb25-cdfc-489d-b870-8a86b31987a2"
/>
---
<img width="760" height="455" alt="Screenshot 2026-06-24 at 15 56 37"
src="https://github.com/user-attachments/assets/2eccc444-60fb-4bb0-a731-02d28d70c65d"
/>1 parent daa7768 commit 0042785
11 files changed
Lines changed: 819 additions & 163 deletions
File tree
- lib/rdoc/generator/template/aliki
- css
- js
- test/rdoc/generator
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
4 | 4 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | | - | |
| 1 | + | |
2 | 2 | | |
3 | 3 | | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
3 | 3 | | |
4 | 4 | | |
5 | 5 | | |
6 | | - | |
| 6 | + | |
7 | 7 | | |
8 | 8 | | |
9 | 9 | | |
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
33 | | - | |
34 | | - | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
35 | 36 | | |
36 | 37 | | |
37 | 38 | | |
| |||
127 | 128 | | |
128 | 129 | | |
129 | 130 | | |
130 | | - | |
131 | | - | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
132 | 145 | | |
133 | 146 | | |
134 | | - | |
135 | | - | |
136 | | - | |
137 | | - | |
138 | | - | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
139 | 155 | | |
140 | 156 | | |
141 | 157 | | |
142 | | - | |
143 | | - | |
144 | | - | |
145 | | - | |
146 | | - | |
147 | | - | |
148 | | - | |
149 | | - | |
150 | | - | |
151 | | - | |
152 | | - | |
153 | | - | |
154 | | - | |
155 | | - | |
156 | 158 | | |
157 | | - | |
158 | | - | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
159 | 170 | | |
160 | 171 | | |
161 | 172 | | |
162 | 173 | | |
163 | | - | |
164 | | - | |
165 | | - | |
166 | | - | |
167 | | - | |
168 | 174 | | |
169 | 175 | | |
170 | 176 | | |
| |||
0 commit comments