rdoc 6.16.1 → 7.0.0

data/lib/rdoc/generator/template/aliki/css/rdoc.css

@@ -85,6 +85,16 @@
   --color-th-background: var(--color-neutral-100);
   --color-td-background: var(--color-neutral-50);
 
+  /* Search Type Badge Colors */
+  --color-search-type-class-bg: #e6f0ff;
+  --color-search-type-class-text: #0050a0;
+  --color-search-type-module-bg: #e6ffe6;
+  --color-search-type-module-text: #060;
+  --color-search-type-constant-bg: #fff0e6;
+  --color-search-type-constant-text: #995200;
+  --color-search-type-method-bg: #f0e6ff;
+  --color-search-type-method-text: #5200a0;
+
   /* RGBA Colors (theme-agnostic) */
   --color-overlay: rgb(0 0 0 / 50%);
   --color-emphasis-bg: rgb(255 111 97 / 10%);
@@ -142,12 +152,13 @@
 
   /* Shadows */
   --shadow-sm: 0 1px 3px 0 rgb(0 0 0 / 10%), 0 1px 2px -1px rgb(0 0 0 / 10%);
+  --shadow-md: 0 2px 8px rgb(0 0 0 / 10%);
   --shadow-lg: 0 10px 15px -3px rgb(0 0 0 / 10%), 0 4px 6px -4px rgb(0 0 0 / 10%);
   --shadow-xl: 0 20px 25px -5px rgb(0 0 0 / 10%), 0 8px 10px -6px rgb(0 0 0 / 10%);
 
   /* Layout Dimensions */
-  --layout-sidebar-width: 280px;
-  --layout-sidebar-width-min: 240px;
+  --layout-sidebar-width: 300px;
+  --layout-sidebar-width-min: 300px;
   --layout-sidebar-width-max: 15%;
   --layout-toc-width-min: 240px;
   --layout-toc-width-max: 18%;
@@ -158,6 +169,13 @@
   /* Transitions */
   --transition-fast: 150ms ease-in-out;
   --transition-base: 200ms ease-in-out;
+  --transition-slow: 350ms ease-in-out;
+  --ease-out-smooth: cubic-bezier(0.4, 0, 0.2, 1);
+
+  /* Animation Durations */
+  --duration-fast: 250ms;
+  --duration-base: 300ms;
+  --duration-medium: 350ms;
 
   /* Z-Index Scale */
   --z-fixed: 300;
@@ -202,6 +220,7 @@
   --color-accent-primary: var(--color-primary-500);
   --color-accent-hover: var(--color-primary-400);
   --color-accent-subtle: rgb(235 84 79 / 10%);
+  --color-accent-subtle-hover: rgb(235 84 79 / 20%);
   --color-code-bg: var(--color-neutral-800);
   --color-code-border: var(--color-neutral-700);
   --color-nav-bg: var(--color-neutral-900);
@@ -209,8 +228,19 @@
   --color-th-background: var(--color-background-tertiary);
   --color-td-background: var(--color-background-secondary);
 
+  /* Search Type Badge Colors - Dark Theme */
+  --color-search-type-class-bg: #1e3a5f;
+  --color-search-type-class-text: #93c5fd;
+  --color-search-type-module-bg: #14532d;
+  --color-search-type-module-text: #86efac;
+  --color-search-type-constant-bg: #451a03;
+  --color-search-type-constant-text: #fcd34d;
+  --color-search-type-method-bg: #3b0764;
+  --color-search-type-method-text: #d8b4fe;
+
   /* Dark theme shadows (slightly more subtle) */
   --shadow-sm: 0 1px 3px 0 rgb(0 0 0 / 40%), 0 1px 2px -1px rgb(0 0 0 / 40%);
+  --shadow-md: 0 2px 8px rgb(0 0 0 / 40%);
   --shadow-lg: 0 10px 15px -3px rgb(0 0 0 / 40%), 0 4px 6px -4px rgb(0 0 0 / 40%);
   --shadow-xl: 0 20px 25px -5px rgb(0 0 0 / 40%), 0 8px 10px -6px rgb(0 0 0 / 40%);
 
@@ -228,13 +258,13 @@ body {
 
   /* Grid layout with header, sidebar, main, and footer */
   display: grid;
-  grid-template: "header header" var(--layout-header-height) "nav main" 1fr "nav footer" auto / minmax(var(--layout-sidebar-width-min), var(--layout-sidebar-width-max)) 1fr;
+  grid-template: "header header" var(--layout-header-height) "nav main" 1fr "nav footer" auto / var(--layout-sidebar-width) 1fr;
   min-height: 100vh;
 }
 
 /* Three-column layout when TOC is present */
 body.has-toc {
-  grid-template: "header header header" var(--layout-header-height) "nav main toc" 1fr "nav footer toc" auto / minmax(var(--layout-sidebar-width-min), var(--layout-sidebar-width-max)) 1fr minmax(var(--layout-toc-width-min), var(--layout-toc-width-max));
+  grid-template: "header header header" var(--layout-header-height) "nav main toc" 1fr "nav footer toc" auto / var(--layout-sidebar-width) 1fr minmax(var(--layout-toc-width-min), var(--layout-toc-width-max));
   min-height: 100vh;
 }
 
@@ -291,7 +321,12 @@ pre {
   border-radius: var(--radius-sm);
   cursor: pointer;
   opacity: 0.6;
-  transition: opacity var(--transition-fast), background var(--transition-fast), border-color var(--transition-fast), transform var(--transition-fast);
+  transition:
+    opacity var(--transition-fast),
+    background var(--transition-fast),
+    border-color var(--transition-fast),
+    transform var(--transition-fast),
+    box-shadow var(--transition-fast);
   display: flex;
   align-items: center;
   justify-content: center;
@@ -305,10 +340,18 @@ pre {
   opacity: 1;
   background: var(--color-background-tertiary);
   border-color: var(--color-border-emphasis);
+  transform: translateY(-1px);
+  box-shadow: var(--shadow-md);
+}
+
+.copy-code-button:focus {
+  outline: none;
+  box-shadow: 0 0 0 3px var(--color-accent-subtle);
 }
 
 .copy-code-button:active {
-  transform: scale(0.95);
+  transform: scale(0.92);
+  box-shadow: none;
 }
 
 .copy-code-button svg {
@@ -320,7 +363,7 @@ pre {
   stroke-linecap: round;
   stroke-linejoin: round;
   color: var(--color-text-secondary);
-  transition: color var(--transition-fast);
+  transition: color var(--transition-fast), transform var(--transition-base);
 }
 
 .copy-code-button:hover svg {
@@ -457,7 +500,11 @@ header.top-navbar .navbar-search form {
   border-radius: var(--radius-md);
   color: var(--color-text-primary);
   cursor: pointer;
-  transition: background var(--transition-fast), border-color var(--transition-fast), color var(--transition-fast);
+  transition:
+    background var(--transition-fast),
+    border-color var(--transition-fast),
+    color var(--transition-fast),
+    transform var(--transition-fast);
   font-size: var(--font-size-lg);
   line-height: 1;
   width: 2.5rem;
@@ -468,6 +515,7 @@ header.top-navbar .navbar-search form {
   background: var(--color-background-secondary);
   border-color: var(--color-accent-primary);
   color: var(--color-accent-primary);
+  transform: scale(1.05);
 }
 
 .theme-toggle:focus {
@@ -476,13 +524,17 @@ header.top-navbar .navbar-search form {
   box-shadow: 0 0 0 3px var(--color-accent-subtle);
 }
 
+.theme-toggle:active {
+  transform: scale(0.95);
+}
+
 .theme-toggle-icon {
   display: inline-block;
-  transition: transform var(--transition-base);
+  transition: transform var(--duration-base) var(--ease-out-smooth);
 }
 
 .theme-toggle:hover .theme-toggle-icon {
-  transform: rotate(20deg);
+  transform: rotate(15deg) scale(1.1);
 }
 
 /* Mobile navbar */
@@ -537,12 +589,33 @@ nav {
   background: var(--color-nav-bg);
   color: var(--color-nav-text);
   overflow: hidden auto;
+  overscroll-behavior: contain;
   display: flex;
   flex-direction: column;
   position: sticky;
   top: var(--layout-header-height);
   height: calc(100vh - var(--layout-header-height));
-  align-self: start;
+  scrollbar-width: thin;
+  scrollbar-color: var(--color-border-default) transparent;
+}
+
+/* Custom scrollbar for WebKit browsers */
+nav::-webkit-scrollbar {
+  width: 6px;
+}
+
+nav::-webkit-scrollbar-track {
+  background: transparent;
+}
+
+nav::-webkit-scrollbar-thumb {
+  background: var(--color-border-default);
+  border-radius: var(--radius-sm);
+  transition: background var(--transition-fast);
+}
+
+nav::-webkit-scrollbar-thumb:hover {
+  background: var(--color-border-emphasis);
 }
 
 /* Mobile navigation */
@@ -616,6 +689,18 @@ nav ul li {
   line-height: var(--line-height-relaxed);
 }
 
+nav ul li a {
+  padding: var(--space-1) 0;
+  transition:
+    color var(--transition-fast),
+    transform var(--transition-fast),
+    padding var(--transition-fast);
+}
+
+nav ul li a:hover {
+  padding-left: var(--space-1);
+}
+
 nav ul ul {
   padding-left: var(--space-5);
   margin-top: var(--space-2);
@@ -633,6 +718,17 @@ nav a {
   text-decoration: none;
 }
 
+/* Truncation for direct nav links (not links inside code tags) */
+nav .nav-list > li > a,
+nav .nav-section > ul > li > a,
+nav .nav-section > dl > dd > a {
+  display: block;
+  max-width: 100%;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+
 nav footer {
   padding: var(--space-4);
   border-top: 1px solid var(--color-border-default);
@@ -664,6 +760,8 @@ nav footer a {
     cursor: pointer;
     transition: color var(--transition-fast);
     line-height: 1;
+    user-select: none;
+    -webkit-user-select: none;
   }
 
   #navigation-toggle:hover {
@@ -671,31 +769,153 @@ nav footer a {
   }
 }
 
-nav ul li details > summary {
-  list-style: none;  /* Remove the default marker */
-  position: relative; /* So that the open/close triangle can position itself absolutely inside */
+/*
+ * Shared Collapsible Animation using ::details-content pseudo-element.
+ * This is the modern CSS approach for animating <details> elements.
+ * Uses block-size animation with interpolate-size for smooth height transitions.
+ * Both nav-section-collapsible and nested link-list details share this pattern.
+ */
+nav details {
+  interpolate-size: allow-keywords;
+}
+
+nav details::details-content {
+  overflow: hidden;
+  block-size: 0;
+  transition: block-size 200ms ease, content-visibility 200ms ease allow-discrete;
 }
 
-nav ul li details > summary::-webkit-details-marker {
-  display: none;  /* Removes the default marker, in Safari 18. */
+nav details[open]::details-content {
+  block-size: auto;
 }
 
-nav ul li details > summary::after {
-  content: '▶';  /* Unicode right-pointing triangle */
-  position: absolute;
-  font-size: 0.8em;
-  bottom: 0.1em;
-  margin-left: 0.3em;
+/* Collapsible Navigation Section Headers */
+
+nav .nav-section-header {
+  display: flex;
+  align-items: center;
+  gap: var(--space-3);
+  padding: var(--space-3) 0;
+  cursor: pointer;
+  list-style: none;
+  user-select: none;
+  -webkit-user-select: none;
+  border-bottom: 1px solid var(--color-border-default);
+  margin-bottom: var(--space-3);
+  transition: color var(--transition-fast);
+}
+
+nav .nav-section-header::-webkit-details-marker {
+  display: none;
+}
+
+nav .nav-section-header:hover {
+  color: var(--color-accent-primary);
+}
+
+nav .nav-section-icon {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  width: 1.25rem;
+  height: 1.25rem;
+  flex-shrink: 0;
+  color: var(--color-accent-primary);
+}
+
+nav .nav-section-icon svg {
+  width: 100%;
+  height: 100%;
+}
+
+nav .nav-section-title {
+  font-size: var(--font-size-base);
+  font-weight: var(--font-weight-semibold);
+  color: inherit;
+  flex: 1;
+  min-width: 0;
+  overflow: hidden;
+  text-overflow: ellipsis;
+  white-space: nowrap;
+}
+
+nav .nav-section-chevron {
+  display: flex;
+  align-items: center;
+  justify-content: center;
+  width: 1rem;
+  height: 1rem;
+  flex-shrink: 0;
+  color: var(--color-text-tertiary);
   transition: transform var(--transition-base);
 }
 
-nav ul li details[open] > summary::after {
-  transform: rotate(90deg);  /* Rotate the triangle when open */
+nav .nav-section-chevron svg {
+  width: 100%;
+  height: 100%;
 }
 
-/* Global link hover state is defined after navigation to keep specificity ordering */
-a:hover {
-  color: var(--color-link-hover);
+/* Rotate chevron when open */
+nav .nav-section-collapsible[open] > .nav-section-header .nav-section-chevron {
+  transform: rotate(90deg);
+}
+
+nav .nav-section-collapsible > ul,
+nav .nav-section-collapsible > dl,
+nav .nav-section-collapsible > p {
+  margin-top: 0;
+}
+
+nav .nav-section-collapsible > .nav-list {
+  padding-left: var(--space-5);
+  border-left: 1px solid var(--color-border-subtle);
+  margin-left: 9px; /* Align with the section icon center */
+}
+
+nav .nav-section-collapsible .nav-list .link-list {
+  border-left: none;
+  margin-left: 0;
+  padding-left: var(--space-5);
+}
+
+/*
+  Improve chevron styling for details under link-list, using SVG chevron that matches nav-section-chevron
+  We need to avoid adding the element in class content generation so it doesn't break darkfish styles
+*/
+nav li details:has(.link-list) > summary {
+  display: inline-flex;
+  align-items: center;
+  gap: var(--space-2);
+  cursor: pointer;
+}
+
+nav li details:has(.link-list) > summary::after {
+  content: '';
+  position: static;
+  display: inline-block;
+  width: 1rem;
+  height: 1rem;
+  flex-shrink: 0;
+  margin-left: 0;
+  background-color: var(--color-text-secondary);
+  mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpolyline points='9 18 15 12 9 6'%3E%3C/polyline%3E%3C/svg%3E");
+  mask-size: contain;
+  mask-repeat: no-repeat;
+  mask-position: center;
+  -webkit-mask-image: url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24' fill='none' stroke='currentColor' stroke-width='2' stroke-linecap='round' stroke-linejoin='round'%3E%3Cpolyline points='9 18 15 12 9 6'%3E%3C/polyline%3E%3C/svg%3E");
+  -webkit-mask-size: contain;
+  -webkit-mask-repeat: no-repeat;
+  -webkit-mask-position: center;
+  transition: transform var(--transition-base), background-color var(--transition-fast);
+}
+
+nav li details:has(.link-list) > summary:hover::after {
+  background-color: var(--color-accent-primary);
+}
+
+nav li details:has(.link-list)[open] > summary::after {
+  transform: rotate(90deg);
+  background-color: var(--color-accent-primary);
 }
 
 /* 8. Main Content (Center Column) */
@@ -995,17 +1215,54 @@ main .anchor-link:target {
 main .method-source-code {
   visibility: hidden;
   max-height: 0;
-  overflow: auto;
-  transition: max-height var(--transition-base), visibility var(--transition-base);
+  overflow: hidden;
+  opacity: 0;
+  transform: translateY(-8px);
+  transition:
+    max-height var(--duration-medium) var(--ease-out-smooth),
+    visibility var(--duration-medium),
+    opacity var(--duration-fast) ease-out,
+    transform var(--duration-fast) ease-out;
 }
 
 main .method-source-code pre {
   border-color: var(--color-accent-hover);
+  border-left: 3px solid var(--color-accent-primary);
+  width: 100%;
+  box-sizing: border-box;
+  transition: border-color var(--transition-fast);
+  scrollbar-width: thin;
+  scrollbar-color: var(--color-border-default) transparent;
+}
+
+main .method-source-code pre::-webkit-scrollbar {
+  width: 6px;
+  height: 6px;
+}
+
+main .method-source-code pre::-webkit-scrollbar-track {
+  background: transparent;
+}
+
+main .method-source-code pre::-webkit-scrollbar-thumb {
+  background: var(--color-border-default);
+  border-radius: var(--radius-sm);
+}
+
+main .method-source-code pre::-webkit-scrollbar-thumb:hover {
+  background: var(--color-border-emphasis);
+}
+
+main .method-source-code pre::-webkit-scrollbar-corner {
+  background: transparent;
 }
 
 main .method-source-code.active-menu {
   visibility: visible;
   max-height: 100vh;
+  overflow: auto;
+  opacity: 1;
+  transform: translateY(0);
 }
 
 main .method-description .method-calls-super {
@@ -1025,6 +1282,7 @@ main .method-detail:target {
 
 main .method-header {
   display: inline-block;
+  max-width: calc(100% - 6em); /* 6em is the width of the source code toggle */
 }
 
 main .method-heading {
@@ -1044,10 +1302,47 @@ main .method-heading .method-args {
 }
 
 main .method-controls {
-  line-height: 20px;
   float: right;
-  color: var(--color-accent-hover);
+}
+
+main .method-controls summary {
+  display: inline-block;
+  line-height: 20px;
+  color: var(--color-accent-primary);
   cursor: pointer;
+  padding: var(--space-1) var(--space-3);
+  border-radius: var(--radius-sm);
+  font-size: var(--font-size-sm);
+  font-weight: var(--font-weight-medium);
+  background: var(--color-accent-subtle);
+  border: 1px solid transparent;
+  transition:
+    color var(--transition-fast),
+    background var(--transition-fast),
+    border-color var(--transition-fast),
+    transform var(--transition-fast);
+  user-select: none;
+  -webkit-user-select: none;
+  list-style: none;
+}
+
+main .method-controls summary::-webkit-details-marker {
+  display: none;
+}
+
+main .method-controls summary:hover {
+  background: var(--color-primary-100);
+  border-color: var(--color-primary-300);
+  transform: translateY(-1px);
+}
+
+main .method-controls summary:active {
+  transform: scale(0.96);
+}
+
+[data-theme="dark"] main .method-controls summary:hover {
+  background: var(--color-accent-subtle-hover);
+  border-color: var(--color-primary-500);
 }
 
 main .method-description,
@@ -1316,6 +1611,14 @@ aside.table-of-contents .toc-sticky nav {
   height: auto;
 }
 
+aside.table-of-contents .toc-list > .toc-h2 {
+  margin-left: var(--space-4);
+}
+
+aside.table-of-contents .toc-list > .toc-h3 {
+  margin-left: var(--space-8);
+}
+
 /* Hide TOC on mobile/tablet */
 @media (width <= 1279px) {
   aside.table-of-contents {
@@ -1323,7 +1626,7 @@ aside.table-of-contents .toc-sticky nav {
   }
 
   body.has-toc {
-    grid-template-columns: minmax(var(--layout-sidebar-width-min), var(--layout-sidebar-width-max)) 1fr;
+    grid-template-columns: var(--layout-sidebar-width) 1fr;
     grid-template-areas:
       "header header"
       "nav main"
@@ -1333,10 +1636,6 @@ aside.table-of-contents .toc-sticky nav {
 
 /* Tablet adjustments (between mobile and desktop) */
 @media (width >= 768px) and (width <= 1023px) {
-  nav {
-    width: 240px;
-  }
-
   header.top-navbar {
     padding: 0 var(--space-6);
   }
@@ -1555,6 +1854,39 @@ footer.site-footer .footer-bottom:first-child {
   font-weight: bold;
 }
 
+#search-results .search-type {
+  display: inline-block;
+  margin-left: var(--space-2);
+  padding: 0 var(--space-2);
+  font-size: var(--font-size-xs);
+  font-weight: 500;
+  border-radius: var(--radius-sm);
+  vertical-align: middle;
+  background: var(--color-background-tertiary);
+  color: var(--color-text-secondary);
+}
+
+#search-results .search-type-class {
+  background: var(--color-search-type-class-bg);
+  color: var(--color-search-type-class-text);
+}
+
+#search-results .search-type-module {
+  background: var(--color-search-type-module-bg);
+  color: var(--color-search-type-module-text);
+}
+
+#search-results .search-type-constant {
+  background: var(--color-search-type-constant-bg);
+  color: var(--color-search-type-constant-text);
+}
+
+#search-results .search-type-instance-method,
+#search-results .search-type-class-method {
+  background: var(--color-search-type-method-bg);
+  color: var(--color-search-type-method-text);
+}
+
 #search-results li em {
   background-color: var(--color-search-highlight-bg);
   font-style: normal;

data/lib/rdoc/generator/template/aliki/index.rhtml

@@ -1,4 +1,5 @@
 <body role="document" class="file has-toc">
+<%= render '_icons.rhtml' %>
 <%= render '_header.rhtml' %>
 <%= render '_sidebar_toggle.rhtml' %>
 

data/lib/rdoc/generator/template/aliki/js/aliki.js

@@ -28,7 +28,7 @@ function createSearchInstance(input, result) {
 
   result.classList.remove("initially-hidden");
 
-  const search = new Search(search_data, input, result);
+  const search = new SearchController(search_data, input, result);
 
   search.renderItem = function(result) {
     const li = document.createElement('li');
@@ -40,8 +40,12 @@ function createSearchInstance(input, result) {
       html += `<span class="params">${result.params}</span>`;
     html += '</a>';
 
-    if (result.namespace)
-      html += `<p class="search-namespace">${this.hlt(result.namespace)}`;
+    // Add type indicator
+    if (result.type) {
+      const typeLabel = this.formatType(result.type);
+      const typeClass = result.type.replace(/_/g, '-');
+      html += `<span class="search-type search-type-${this.escapeHTML(typeClass)}">${typeLabel}</span>`;
+    }
 
     if (result.snippet)
       html += `<div class="search-snippet">${result.snippet}</div>`;
@@ -51,6 +55,17 @@ function createSearchInstance(input, result) {
     return li;
   }
 
+  search.formatType = function(type) {
+    const typeLabels = {
+      'class': 'class',
+      'module': 'module',
+      'constant': 'const',
+      'instance_method': 'method',
+      'class_method': 'method'
+    };
+    return typeLabels[type] || type;
+  }
+
   search.select = function(result) {
     let href = result.firstChild.firstChild.href;
     const query = this.input.value;

data/lib/rdoc/generator/template/aliki/js/{search.js → search_controller.js}

@@ -1,15 +1,15 @@
-Search = function(data, input, result) {
+SearchController = function(data, input, result) {
   this.data = data;
   this.input = input;
   this.result = result;
 
   this.current = null;
   this.view = this.result.parentNode;
-  this.searcher = new Searcher(data.index);
+  this.ranker = new SearchRanker(data.index);
   this.init();
 }
 
-Search.prototype = Object.assign({}, Navigation, new function() {
+SearchController.prototype = Object.assign({}, SearchNavigation, new function() {
   var suid = 1;
 
   this.init = function() {
@@ -25,7 +25,7 @@ Search.prototype = Object.assign({}, Navigation, new function() {
     this.input.addEventListener('keyup', observer);
     this.input.addEventListener('click', observer); // mac's clear field
 
-    this.searcher.ready(function(results, isLast) {
+    this.ranker.ready(function(results, isLast) {
       _this.addResults(results, isLast);
     })
 
@@ -36,7 +36,7 @@ Search.prototype = Object.assign({}, Navigation, new function() {
   this.search = function(value, selectFirstMatch) {
     this.selectFirstMatch = selectFirstMatch;
 
-    value = value.trim().toLowerCase();
+    value = value.trim();
     if (value) {
       this.setNavigationActive(true);
     } else {
@@ -53,7 +53,7 @@ Search.prototype = Object.assign({}, Navigation, new function() {
       this.result.setAttribute('aria-busy',     'true');
       this.result.setAttribute('aria-expanded', 'true');
       this.firstRun = true;
-      this.searcher.find(value);
+      this.ranker.find(value);
     }
   }