Skip to content

Fix sidebar scroll again and add missing footer back #1154

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
merged 3 commits into from
Aug 15, 2024
Merged

Fix sidebar scroll again and add missing footer back #1154

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d928e1e
Add missing footers
st0012 Aug 15, 2024
106bbee
Remove unnecessary middle divs in nav
st0012 Aug 15, 2024
f76e721
Simplify sidebar's overflow settings
st0012 Aug 15, 2024
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
13 changes: 6 additions & 7 deletions lib/rdoc/generator/template/darkfish/class.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,13 @@
</div>

<%= render '_sidebar_table_of_contents.rhtml' %>
<%= render '_sidebar_sections.rhtml' %>
<%= render '_sidebar_parent.rhtml' %>
<%= render '_sidebar_includes.rhtml' %>
<%= render '_sidebar_extends.rhtml' %>
<%= render '_sidebar_methods.rhtml' %>

<div id="class-metadata">
<%= render '_sidebar_sections.rhtml' %>
<%= render '_sidebar_parent.rhtml' %>
<%= render '_sidebar_includes.rhtml' %>
<%= render '_sidebar_extends.rhtml' %>
<%= render '_sidebar_methods.rhtml' %>
</div>
<%= render '_footer.rhtml' %>
</nav>

<main role="main" aria-labelledby="<%=h klass.aref %>">
Expand Down
9 changes: 2 additions & 7 deletions lib/rdoc/generator/template/darkfish/css/rdoc.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ nav {
position: fixed;
top: 0;
bottom: 0;
overflow: hidden;
overflow: auto;
z-index: 10;

/* Layout */
Expand All @@ -228,11 +228,6 @@ nav[hidden] {
display: none;
}

nav #project-metadata {
overflow: auto; /* Make the content scrollable */
flex: 1; /* Take up remaining space */
}

nav footer {
padding: 1em;
border-top: 1px solid #ccc;
Expand Down Expand Up @@ -286,7 +281,7 @@ nav .nav-section {
margin-top: 2em;
border-top: 2px solid #aaa;
font-size: 90%;
overflow: hidden;
flex: 1;
}

nav h2 {
Expand Down
7 changes: 2 additions & 5 deletions lib/rdoc/generator/template/darkfish/index.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,11 @@
<nav id="navigation" role="navigation">
<div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %>

<%= render '_sidebar_search.rhtml' %>
</div>

<div id="project-metadata">
<%= render '_sidebar_pages.rhtml' %>
<%= render '_sidebar_classes.rhtml' %>
</div>
<%= render '_sidebar_pages.rhtml' %>
<%= render '_sidebar_classes.rhtml' %>

<%= render '_footer.rhtml' %>
</nav>
Expand Down
5 changes: 2 additions & 3 deletions lib/rdoc/generator/template/darkfish/page.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,9 @@
</div>

<%= render '_sidebar_table_of_contents.rhtml' %>
<%= render '_sidebar_pages.rhtml' %>

<div id="project-metadata">
<%= render '_sidebar_pages.rhtml' %>
</div>
<%= render '_footer.rhtml' %>
</nav>

<main role="main" aria-label="Page <%=h file.full_name%>">
Expand Down
13 changes: 7 additions & 6 deletions lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,15 @@
<%= render '_sidebar_toggle.rhtml' %>

<nav id="navigation" role="navigation">
<%= render '_sidebar_navigation.rhtml' %>
<div id="project-navigation">
<%= render '_sidebar_navigation.rhtml' %>
<%= render '_sidebar_search.rhtml' %>
</div>

<%= render '_sidebar_search.rhtml' %>
<%= render '_sidebar_pages.rhtml' %>
<%= render '_sidebar_classes.rhtml' %>

<div id="project-metadata">
<%= render '_sidebar_pages.rhtml' %>
<%= render '_sidebar_classes.rhtml' %>
</div>
<%= render '_footer.rhtml' %>
</nav>

<main role="main">
Expand Down
3 changes: 2 additions & 1 deletion lib/rdoc/generator/template/darkfish/servlet_root.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
<%= render '_sidebar_search.rhtml' %>
</div>

<%= render '_sidebar_installed.rhtml' %>
<%= render '_sidebar_installed.rhtml' %>
<%= render '_footer.rhtml' %>
</nav>

<main role="main">
Expand Down
2 changes: 2 additions & 0 deletions lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

<%= render '_sidebar_search.rhtml' %>
</div>

<%= render '_footer.rhtml' %>
</nav>
<main role="main">
<h1 class="class"><%= h @title %></h1>
Expand Down
2 changes: 1 addition & 1 deletion test/rdoc/test_rdoc_generator_darkfish.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def test_generate
assert_match(%r[Klass/Inner\.html".*>Inner<], summary)

klass = File.binread('Klass.html')
klassnav = klass[%r[<div class="nav-section">.*<div id="class-metadata">]m]
klassnav = klass[%r[<div class="nav-section">.*]m]
assert_match(
%r[<li>\s*<details open>\s*<summary>\s*<a href=\S+>Heading 1</a>\s*</summary>\s*<ul]m,
klassnav
Expand Down