Skip to content

Polish Aliki documentation theme #1742

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.

Sign up for GitHub

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

Merged
st0012 merged 11 commits into from
Jun 25, 2026
Merged

Polish Aliki documentation theme #1742

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
7b191f1
Add DESIGN.md visual design spec for the Aliki theme
st0012 Jun 13, 2026
4d1338f
Quiet Aliki method and source borders
st0012 Jun 15, 2026
8754dc9
Tighten Aliki nested nav spacing
st0012 Jun 15, 2026
d6f465e
Clarify Aliki sidebar and TOC selectors
st0012 Jun 15, 2026
fbc6adc
Integrate Aliki method source controls
st0012 Jun 24, 2026
1a1edd5
Strengthen Aliki signature card borders
st0012 Jun 24, 2026
9324f17
Soften Aliki section dividers
st0012 Jun 24, 2026
03aa889
Clarify Aliki page title kind
st0012 Jun 24, 2026
8f05cdd
Fix Aliki footer breakpoint layout
st0012 Jun 24, 2026
331726f
Align Aliki search with content rail
st0012 Jun 24, 2026
cd2b3a1
Update Aliki navigation test selectors
st0012 Jun 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
536 changes: 536 additions & 0 deletions lib/rdoc/generator/template/aliki/DESIGN.md
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/rdoc/generator/template/aliki/_aside_toc.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<aside class="table-of-contents" role="complementary" aria-label="Table of Contents">
<aside id="table-of-contents" class="table-of-contents" role="complementary" aria-label="Table of Contents">
<div class="toc-sticky">
<h3 class="toc-heading">On This Page</h3>
<nav class="toc-nav" id="toc-nav" aria-label="Page sections">
Expand Down
2 changes: 1 addition & 1 deletion lib/rdoc/generator/template/aliki/_sidebar_toggle.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<div id="navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="true" aria-controls="navigation">
<div id="sidebar-navigation-toggle" role="button" tabindex="0" aria-label="Toggle sidebar" aria-expanded="false" aria-controls="sidebar-navigation">
<span aria-hidden="true">&#9776;</span>
</div>
68 changes: 37 additions & 31 deletions lib/rdoc/generator/template/aliki/class.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<%= render '_header.rhtml' %>
<%= render '_sidebar_toggle.rhtml' %>

<nav id="navigation" role="navigation" hidden>
<nav id="sidebar-navigation" role="navigation" hidden>
<%= render '_sidebar_pages.rhtml' %>
<%= render '_sidebar_sections.rhtml' %>
<%= render '_sidebar_ancestors.rhtml' %>
Expand All @@ -30,8 +30,9 @@
<% end %>

<span id="<%= h klass.legacy_aref %>" class="legacy-anchor"></span>
<h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %>">
<%= klass.type %> <%= klass.full_name %>
<h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %> page-title">
<span class="page-title-kind"><%= klass.type %></span>
<span class="page-title-name"><%= klass.full_name %></span>
</h1>

<section class="description">
Expand Down Expand Up @@ -127,44 +128,49 @@
<%- methods.each do |method| %>
<div id="<%= method.aref %>" class="method-detail anchor-link <%= method.is_alias_for ? "method-alias" : '' %>">
<div class="method-header">
<%- if (call_seq = method.call_seq) %>
<%- call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
<div class="method-heading-group">
<%- if (call_seq = method.call_seq) %>
<%- call_seq.strip.split("\n").each_with_index do |call_seq, i| %>
<div class="method-heading">
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-callseq">
<%= h(call_seq.strip.
gsub( /^\w+\./m, '')).
gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
</span>
</a>
</div>
<%- end %>
<%- elsif method.has_call_seq? %>
<div class="method-heading">
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-callseq">
<%= h(call_seq.strip.
gsub( /^\w+\./m, '')).
gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
</span>
<span class="method-name"><%= h method.name %></span>
</a>
</div>
<%- else %>
<div class="method-heading">
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-name"><%= h method.name %></span>
<span class="method-args"><%= h method.param_seq %></span>
</a>
</div>
<%- end %>
<%- elsif method.has_call_seq? %>
<div class="method-heading">
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-name"><%= h method.name %></span>
</a>
</div>
<%- else %>
<div class="method-heading">
<a href="#<%= method.aref %>" title="Link to this method">
<span class="method-name"><%= h method.name %></span>
<span class="method-args"><%= h method.param_seq %></span>
</a>
</div>
<%- end %>

<%- if (sig_html = type_signature_html(method, klass.path)) %>
<pre class="method-type-signature"><code><%= sig_html %></code></pre>
<%- if (sig_html = type_signature_html(method, klass.path)) %>
<pre class="method-type-signature"><code><%= sig_html %></code></pre>
<%- end %>
</div>

<%- if method.token_stream %>
<div class="method-controls">
<details class="method-source-toggle">
<summary><span class="method-source-icon" aria-hidden="true">{}</span> Source</summary>
</details>
</div>
<%- end %>
</div>

<%- if method.token_stream %>
<div class="method-controls">
<details class="method-source-toggle">
<summary>Source</summary>
</details>
</div>
<div class="method-source-code" id="<%= method.html_name %>-source">
<pre class="<%= method.source_language %>"><%= method.markup_code %></pre>
</div>
Expand Down
Loading
Loading