RubyGems - hotdocs - Versions diffs - 0.4.0 → 0.7.0 - Mend

hotdocs 0.4.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (16) hide show

checksums.yaml +4 -4
data/README.md +2 -2
data/app/assets/images/hotdocs/icon.svg +1 -1
data/app/assets/javascript/controllers/input_cycler_controller.js +19 -0
data/app/assets/javascript/controllers/{search_controller.js → lunr_controller.js} +1 -1
data/app/assets/stylesheets/hotdocs/application.css +919 -668
data/app/assets/stylesheets/hotdocs/reset.css +338 -336
data/app/helpers/hotdocs/application_helper.rb +60 -6
data/app/views/hotdocs/_menu_row.html.erb +26 -7
data/app/views/layouts/hotdocs/application.html.erb +88 -60
data/lib/hotdocs/markdown.rb +1 -3
data/lib/hotdocs/version.rb +1 -1
data/lib/install/install.rb +26 -5
data/lib/tasks/hotdocs_tasks.rake +24 -19
metadata +3 -3
data/lib/hotdocs/kramdown_alerts.rb +0 -92

data/app/helpers/hotdocs/application_helper.rb CHANGED Viewed

@@ -29,8 +29,9 @@ module Hotdocs
         concat(content_tag(:span, name))
         concat(<<~SVG.gsub(/\n/, "").html_safe)
-          <svg aria-hidden="true" viewBox="0 0 24 24" class="external-link__icon">
-            <path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path>
+          <svg aria-hidden="true" class="external-link__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640">
+            <!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.-->
+            <path fill="currentColor" d="M384 64C366.3 64 352 78.3 352 96C352 113.7 366.3 128 384 128L466.7 128L265.3 329.4C252.8 341.9 252.8 362.2 265.3 374.7C277.8 387.2 298.1 387.2 310.6 374.7L512 173.3L512 256C512 273.7 526.3 288 544 288C561.7 288 576 273.7 576 256L576 96C576 78.3 561.7 64 544 64L384 64zM144 160C99.8 160 64 195.8 64 240L64 496C64 540.2 99.8 576 144 576L400 576C444.2 576 480 540.2 480 496L480 416C480 398.3 465.7 384 448 384C430.3 384 416 398.3 416 416L416 496C416 504.8 408.8 512 400 512L144 512C135.2 512 128 504.8 128 496L128 240C128 231.2 135.2 224 144 224L224 224C241.7 224 256 209.7 256 192C256 174.3 241.7 160 224 160L144 160z"/>
           </svg>
         SVG
       end
@@ -62,8 +63,9 @@ module Hotdocs
       link_to(href, html_options) do
         concat(<<~SVG.html_safe)
-          <svg aria-hidden="true" viewBox="0 0 40 40" class="edit-link__icon">
-            <path fill="currentColor" d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path>
+          <svg aria-hidden="true" class="edit-link__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640">
+            <!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.-->
+            <path fill="currentColor" d="M416.9 85.2L372 130.1L509.9 268L554.8 223.1C568.4 209.6 576 191.2 576 172C576 152.8 568.4 134.4 554.8 120.9L519.1 85.2C505.6 71.6 487.2 64 468 64C448.8 64 430.4 71.6 416.9 85.2zM338.1 164L122.9 379.1C112.2 389.8 104.4 403.2 100.3 417.8L64.9 545.6C62.6 553.9 64.9 562.9 71.1 569C77.3 575.1 86.2 577.5 94.5 575.2L222.3 539.7C236.9 535.6 250.2 527.9 261 517.1L476 301.9L338.1 164z"/>
           </svg>
         SVG
@@ -81,6 +83,58 @@ module Hotdocs
       content_tag(:div, id: id, data: data, style: "visibility: hidden;", &)
     end
+    PATHS_BY_ALERT_TYPE = {
+      "danger" => [
+        "M15.362 5.214A8.252 8.252 0 0 1 12 21 8.25 8.25 0 0 1 6.038 7.047 8.287 8.287 0 0 0 9 9.601a8.983 8.983 0 0 1 3.361-6.867 8.21 8.21 0 0 0 3 2.48Z",
+        "M12 18a3.75 3.75 0 0 0 .495-7.468 5.99 5.99 0 0 0-1.925 3.547 5.975 5.975 0 0 1-2.133-1.001A3.75 3.75 0 0 0 12 18Z"
+      ],
+      "warning" => [
+        "M12 9v3.75m-9.303 3.376c-.866 1.5.217 3.374 1.948 3.374h14.71c1.73 0 2.813-1.874 1.948-3.374L13.949 3.378c-.866-1.5-3.032-1.5-3.898 0L2.697 16.126ZM12 15.75h.007v.008H12v-.008Z"
+      ],
+      "tip" => [
+        "M12 18v-5.25m0 0a6.01 6.01 0 0 0 1.5-.189m-1.5.189a6.01 6.01 0 0 1-1.5-.189m3.75 7.478a12.06 12.06 0 0 1-4.5 0m3.75 2.383a14.406 14.406 0 0 1-3 0M14.25 18v-.192c0-.983.658-1.823 1.508-2.316a7.5 7.5 0 1 0-7.517 0c.85.493 1.509 1.333 1.509 2.316V18"
+      ],
+      "info" => [
+        "m11.25 11.25.041-.02a.75.75 0 0 1 1.063.852l-.708 2.836a.75.75 0 0 0 1.063.853l.041-.021M21 12a9 9 0 1 1-18 0 9 9 0 0 1 18 0Zm-9-3.75h.008v.008H12V8.25Z"
+      ]
+    }
+    def alert(type, &block)
+      paths = PATHS_BY_ALERT_TYPE.fetch(type.to_s)
+      content_tag(:div, class: "alert alert--#{type}") do
+        content_tag(:div) do
+          concat(
+            content_tag(:div, class: "alert__header") do
+              concat(
+                content_tag(
+                  :svg,
+                  class: "alert__icon",
+                  xmlns: "http://www.w3.org/2000/svg",
+                  fill: "none",
+                  viewBox: "0 0 24 24",
+                  "stroke-width": "1.5",
+                  stroke: "currentColor"
+                ) do
+                  paths.each do |path|
+                    concat(content_tag(:path, {}, "stroke-linecap": "round", "stroke-linejoin": "round", d: path))
+                  end
+                end
+              )
+              concat(content_tag(:span, type.upcase, class: "alert__label"))
+            end
+          )
+          concat(content_tag(:div, class: "alert__content", &block))
+        end
+      end
+    end
+    def external_url?(url)
+      !URI.parse(url).host.nil?
+    rescue URI::InvalidURIError
+      false
+    end
     private
     def active_link?(url)
@@ -92,7 +146,7 @@ module Hotdocs
       new_items = items.map do |item|
         children, expanded_below = compute_menu_r(item[:children])
-        active = active_link?(item.fetch(:url))
+        active = active_link?(item.fetch(:url, nil))
         expanded = expanded_below || item[:expanded] || active
         { **item, expanded: expanded, children: children }
       end
@@ -106,7 +160,7 @@ module Hotdocs
       content_tag(:ul, class: "menu__section") do
         items.each do |item|
           concat(content_tag(:li) do
-            locals = { expanded: item.fetch(:expanded), label: item.fetch(:label), url: item.fetch(:url) }
+            locals = { expanded: item.fetch(:expanded), label: item.fetch(:label), url: item.fetch(:url, nil) }
             concat(render partial: "hotdocs/menu_row", locals: locals)
             concat(menu_r(item.fetch(:children)))

data/app/views/hotdocs/_menu_row.html.erb CHANGED Viewed

@@ -1,11 +1,30 @@
 <%# locals: (label:, url:, expanded: false) -%>
-<%= content_tag :div, class: "menu__row", data: { "controller": "accordion", "accordion-expanded-class-value": "menu__row--expanded", "accordion-expanded-value": expanded, "accordion-collapsed-aria-label-value": "Expand menu row '#{label}'", "accordion-expanded-aria-label-value": "Collapse menu row '#{label}'" } do %>
-  <%= active_link_to label, url, class: "menu__link" %>
+<% if url.nil? %>
+  <%= content_tag :div, class: "menu__row", data: { "controller": "accordion", "accordion-expanded-class-value": "menu__row--expanded", "accordion-expanded-value": expanded, "accordion-collapsed-aria-label-value": "Expand menu row '#{label}'", "accordion-expanded-aria-label-value": "Collapse menu row '#{label}'" } do %>
+    <%= content_tag :button, type: "button", class: "menu__toggle menu__toggle--full", data: { action: "click->accordion#toggle", "accordion-target": "toggle" } do %>
+      <%= content_tag :span, label, class: "menu__link" %>
-  <button type="button" class="menu__toggle" data-action="click->accordion#toggle" data-accordion-target="toggle">
-    <svg class="menu__toggle-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
-      <path fill="currentColor" d="M7.41 15.41L12 10.83l4.59 4.58L18 14l-6-6-6 6z"></path>
-    </svg>
-  </button>
+      <div class="menu__toggle-icon-wrapper">
+        <svg aria-hidden="true" class="menu__toggle-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640">
+          <!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.-->
+          <path fill="currentColor" d="M471.1 297.4C483.6 309.9 483.6 330.2 471.1 342.7L279.1 534.7C266.6 547.2 246.3 547.2 233.8 534.7C221.3 522.2 221.3 501.9 233.8 489.4L403.2 320L233.9 150.6C221.4 138.1 221.4 117.8 233.9 105.3C246.4 92.8 266.7 92.8 279.2 105.3L471.2 297.3z"/>
+        </svg>
+      </div>
+    <% end %>
+  <% end %>
+<% else %>
+  <%= content_tag :div, class: "menu__row", data: { "controller": "accordion", "accordion-expanded-class-value": "menu__row--expanded", "accordion-expanded-value": expanded, "accordion-collapsed-aria-label-value": "Expand menu row '#{label}'", "accordion-expanded-aria-label-value": "Collapse menu row '#{label}'" } do %>
+    <%= active_link_to label, url, class: "menu__link" unless external_url?(url) %>
+    <%= external_link_to label, url, class: "menu__link" if external_url?(url) %>
+    <%= content_tag :button, type: "button", class: "menu__toggle", data: { action: "click->accordion#toggle", "accordion-target": "toggle" } do %>
+      <div class="menu__toggle-icon-wrapper">
+        <svg aria-hidden="true" class="menu__toggle-icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640">
+          <!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.-->
+          <path fill="currentColor" d="M471.1 297.4C483.6 309.9 483.6 330.2 471.1 342.7L279.1 534.7C266.6 547.2 246.3 547.2 233.8 534.7C221.3 522.2 221.3 501.9 233.8 489.4L403.2 320L233.9 150.6C221.4 138.1 221.4 117.8 233.9 105.3C246.4 92.8 266.7 92.8 279.2 105.3L471.2 297.3z"/>
+        </svg>
+      </div>
+    <% end %>
+  <% end %>
 <% end %>

data/app/views/layouts/hotdocs/application.html.erb CHANGED Viewed

@@ -1,56 +1,28 @@
 <!DOCTYPE html>
-<html data-theme="light" lang="<%= I18n.locale %>">
+<html lang="<%= I18n.locale %>">
   <head>
     <title><%= content_for(:title) %></title>
     <%= yield :head %>
-    <%= stylesheet_link_tag "hotdocs/reset", media: "all", "data-turbo-track": "reload" %>
     <%= stylesheet_link_tag "hotdocs/application", media: "all", "data-turbo-track": "reload" %>
   </head>
-  <body data-controller="search">
-    <dialog data-search-target="search" class="search">
-      <div data-search-target="dialog" class="search__dialog">
-        <div class="search__header">
-          <input autofocus data-action="input->search#search" type="text" class="search__input"></input>
-          <button aria-label="Close search dialog" type="button" class="search__dismiss" data-action="click->search#close">
-            <svg viewBox="0 0 15 15">
-              <g stroke="currentColor" stroke-width="1.2">
-                <path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path>
-              </g>
-            </svg>
-          </button>
-        </div>
-        <template data-search-target="resultTemplate">
-          <li class="search__result">
-            <h1></h1>
-            <a href="#" class="search__result-excerpt"></a>
-          </li>
-        </template>
-        <ul data-search-target="results">
-          <li class="search__result search__result--loading">
-            Loading index...
-          </li>
-        </ul>
-      </div>
-      <script type="application/json" data-search-target="data">
-        <%= raw(Rails.application.assets.resolver.read("search_data.json")&.force_encoding("UTF-8") || [].to_json) %>
-      </script>
-    </dialog>
+  <body>
+    <% if content_for?(:announcement) %>
+      <%= content_for(:announcement) %>
+    <% end %>
     <% if content_for?(:hotdocs_nav) %>
       <%= content_for(:hotdocs_nav) %>
     <% else %>
-      <nav class="nav" data-controller="sidenav" data-sidenav-open-class-value="sidenav--open" data-sidenav-main-menu-class-value="sidenav__sections--main">
+      <nav class="reset nav" data-controller="sidenav" data-sidenav-open-class-value="sidenav--open" data-sidenav-main-menu-class-value="sidenav__sections--main">
         <div class="nav__section">
           <button class="nav__toggle" type="button" aria-label="Toggle navigation" aria-expanded="false" data-action="click->sidenav#open">
-            <svg viewBox="0 0 30 30" aria-hidden="true">
-              <path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path>
+            <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640">
+              <!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.-->
+              <path fill="currentColor" d="M96 160C96 142.3 110.3 128 128 128L512 128C529.7 128 544 142.3 544 160C544 177.7 529.7 192 512 192L128 192C110.3 192 96 177.7 96 160zM96 320C96 302.3 110.3 288 128 288L512 288C529.7 288 544 302.3 544 320C544 337.7 529.7 352 512 352L128 352C110.3 352 96 337.7 96 320zM544 480C544 497.7 529.7 512 512 512L128 512C110.3 512 96 497.7 96 480C96 462.3 110.3 448 128 448L512 448C529.7 448 544 462.3 544 480z"/>
             </svg>
           </button>
@@ -78,13 +50,66 @@
             <% end %>
           </div>
-          <button type="button" data-action="click->search#open:stop" class="search-button" aria-label="Open search dialog">
-            <svg class="search-button__icon" xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor">
-              <path stroke-linecap="round" stroke-linejoin="round" d="m21 21-5.197-5.197m0 0A7.5 7.5 0 1 0 5.196 5.196a7.5 7.5 0 0 0 10.607 10.607Z" />
-            </svg>
+          <form class="scheme" data-controller="input-cycler" data-turbo-permanent id="scheme">
+            <input class="scheme__input" type="radio" name="scheme" id="scheme-auto" checked />
+            <label class="scheme__icon scheme__icon--auto" role="button" for="scheme-auto" title="System color scheme">
+              <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640"><!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d="M512 320C512 214 426 128 320 128L320 512C426 512 512 426 512 320zM64 320C64 178.6 178.6 64 320 64C461.4 64 576 178.6 576 320C576 461.4 461.4 576 320 576C178.6 576 64 461.4 64 320z"/></svg>
+            </label>
+            <input class="scheme__input" type="radio" name="scheme" id="scheme-light" />
+            <label class="scheme__icon scheme__icon--light" for="scheme-light" title="Light color scheme">
+              <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640"><!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d="M210.2 53.9C217.6 50.8 226 51.7 232.7 56.1L320.5 114.3L408.3 56.1C415 51.7 423.4 50.9 430.8 53.9C438.2 56.9 443.4 63.5 445 71.3L465.9 174.5L569.1 195.4C576.9 197 583.5 202.4 586.5 209.7C589.5 217 588.7 225.5 584.3 232.2L526.1 320L584.3 407.8C588.7 414.5 589.5 422.9 586.5 430.3C583.5 437.7 576.9 443.1 569.1 444.6L465.8 465.4L445 568.7C443.4 576.5 438 583.1 430.7 586.1C423.4 589.1 414.9 588.3 408.2 583.9L320.4 525.7L232.6 583.9C225.9 588.3 217.5 589.1 210.1 586.1C202.7 583.1 197.3 576.5 195.8 568.7L175 465.4L71.7 444.5C63.9 442.9 57.3 437.5 54.3 430.2C51.3 422.9 52.1 414.4 56.5 407.7L114.7 320L56.5 232.2C52.1 225.5 51.3 217.1 54.3 209.7C57.3 202.3 63.9 196.9 71.7 195.4L175 174.6L195.9 71.3C197.5 63.5 202.9 56.9 210.2 53.9zM239.6 320C239.6 275.6 275.6 239.6 320 239.6C364.4 239.6 400.4 275.6 400.4 320C400.4 364.4 364.4 400.4 320 400.4C275.6 400.4 239.6 364.4 239.6 320zM448.4 320C448.4 249.1 390.9 191.6 320 191.6C249.1 191.6 191.6 249.1 191.6 320C191.6 390.9 249.1 448.4 320 448.4C390.9 448.4 448.4 390.9 448.4 320z"/></svg>
+            </label>
+            <input class="scheme__input" type="radio" name="scheme" id="scheme-dark" />
+            <label class="scheme__icon scheme__icon--dark" for="scheme-dark" title="Dark color scheme">
+              <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640"><!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.--><path d="M320 64C178.6 64 64 178.6 64 320C64 461.4 178.6 576 320 576C388.8 576 451.3 548.8 497.3 504.6C504.6 497.6 506.7 486.7 502.6 477.5C498.5 468.3 488.9 462.6 478.8 463.4C473.9 463.8 469 464 464 464C362.4 464 280 381.6 280 280C280 207.9 321.5 145.4 382.1 115.2C391.2 110.7 396.4 100.9 395.2 90.8C394 80.7 386.6 72.5 376.7 70.3C358.4 66.2 339.4 64 320 64z"/></svg>
+            </label>
+          </form>
+          <div class="search-box" data-controller="<%= search_provider %>">
+            <% if search_provider == "lunr" %>
+              <button type="button" data-action="click->lunr#open:stop" class="search-box__button" aria-label="Open search dialog">
+                <svg aria-hidden="true" class="search-box__icon" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640">
+                  <!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.-->
+                  <path fill="currentColor" d="M480 272C480 317.9 465.1 360.3 440 394.7L566.6 521.4C579.1 533.9 579.1 554.2 566.6 566.7C554.1 579.2 533.8 579.2 521.3 566.7L394.7 440C360.3 465.1 317.9 480 272 480C157.1 480 64 386.9 64 272C64 157.1 157.1 64 272 64C386.9 64 480 157.1 480 272zM272 416C351.5 416 416 351.5 416 272C416 192.5 351.5 128 272 128C192.5 128 128 192.5 128 272C128 351.5 192.5 416 272 416z"/>
+                </svg>
+                <span class="search-box__label">Type / to search</span>
+              </button>
+              <dialog data-lunr-target="search" class="reset search">
+                <div data-lunr-target="dialog" class="search__dialog">
+                  <div class="search__header">
+                    <input autofocus data-action="input->lunr#search" type="text" class="search__input"></input>
+                    <button aria-label="Close search dialog" type="button" class="search__dismiss" data-action="click->lunr#close">
+                      <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640">
+                        <!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.-->
+                        <path fill="currentColor" d="M183.1 137.4C170.6 124.9 150.3 124.9 137.8 137.4C125.3 149.9 125.3 170.2 137.8 182.7L275.2 320L137.9 457.4C125.4 469.9 125.4 490.2 137.9 502.7C150.4 515.2 170.7 515.2 183.2 502.7L320.5 365.3L457.9 502.6C470.4 515.1 490.7 515.1 503.2 502.6C515.7 490.1 515.7 469.8 503.2 457.3L365.8 320L503.1 182.6C515.6 170.1 515.6 149.8 503.1 137.3C490.6 124.8 470.3 124.8 457.8 137.3L320.5 274.7L183.1 137.4z"/>
+                      </svg>
+                    </button>
+                  </div>
+                  <template data-lunr-target="resultTemplate">
+                    <li class="search__result">
+                      <h1></h1>
+                      <a href="#" class="search__result-excerpt"></a>
+                    </li>
+                  </template>
+                  <ul data-lunr-target="results">
+                    <li class="search__result search__result--loading">
+                      Loading index...
+                    </li>
+                  </ul>
+                </div>
-            <span class="search-button__label">Type / to search</span>
-          </button>
+                <script type="application/json" data-lunr-target="data">
+                  <%= raw(Rails.application.assets.resolver.read("lunr_data.json")&.force_encoding("UTF-8") || [].to_json) %>
+                </script>
+              </dialog>
+            <% end %>
+          </div>
         </div>
         <div class="sidenav-backdrop"></div>
@@ -101,10 +126,9 @@
             <% end %>
             <button aria-label="Close navigation" class="sidenav__toggle" type="button" data-action="click->sidenav#close">
-              <svg viewBox="0 0 15 15">
-                <g stroke="currentColor" stroke-width="1.2">
-                  <path d="M.75.75l13.5 13.5M14.25.75L.75 14.25"></path>
-                </g>
+              <svg aria-hidden="true" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 640">
+                <!--!Font Awesome Free v7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free Copyright 2025 Fonticons, Inc.-->
+                <path fill="currentColor" d="M183.1 137.4C170.6 124.9 150.3 124.9 137.8 137.4C125.3 149.9 125.3 170.2 137.8 182.7L275.2 320L137.9 457.4C125.4 469.9 125.4 490.2 137.9 502.7C150.4 515.2 170.7 515.2 183.2 502.7L320.5 365.3L457.9 502.6C470.4 515.1 490.7 515.1 503.2 502.6C515.7 490.1 515.7 469.8 503.2 457.3L365.8 320L503.1 182.6C515.6 170.1 515.6 149.8 503.1 137.3C490.6 124.8 470.3 124.8 457.8 137.3L320.5 274.7L183.1 137.4z"/>
               </svg>
             </button>
           </div>
@@ -135,7 +159,7 @@
     <% end %>
     <div class="content">
-      <aside class="menu">
+      <aside class="reset menu">
         <div class="menu__sections">
           <%= menu %>
         </div>
@@ -143,7 +167,7 @@
       <main data-controller="toc" class="main">
         <div class="central">
-          <details name="toc" class="toc">
+          <details name="toc" class="reset toc">
             <summary class="toc__label">Table of contents</summary>
             <ul class="toc__entries" data-toc-target="toc">
@@ -153,19 +177,23 @@
             </ul>
           </details>
-          <article class="article" data-toc-target="article">
+          <div class="article" data-toc-target="article">
             <%= yield %>
-          </article>
+          </div>
-          <%= edit_link %>
+          <div class="reset">
+            <%= edit_link %>
+          </div>
         </div>
-        <div class="sidetoc">
-          <ul class="sidetoc__entries" data-toc-target="sidetoc">
-            <template data-toc-target="sidetocTemplate">
-              <li><a id class="sidetoc__link" href></a></li>
-            </template>
-          </ul>
+        <div class="reset sidetoc">
+          <div class="sidetoc__section">
+            <ul class="sidetoc__entries" data-toc-target="sidetoc">
+              <template data-toc-target="sidetocTemplate">
+                <li><a id class="sidetoc__link" href></a></li>
+              </template>
+            </ul>
+          </div>
         </div>
       </main>
     </div>
@@ -174,7 +202,7 @@
       <%= content_for(:hotdocs_footer) %>
     <% else %>
-      <footer class="footer">
+      <footer class="reset footer">
         <div class="footer__sections">
           <% footer_items.each do |footer_item| %>
             <div class="footer__section">
@@ -195,6 +223,6 @@
       </footer>
     <% end %>
-    <p class="credits">Built with Rails &amp; <a class="credits__link" href="https://hotdocsrails.com">HotDocs<img class="credits__logo" src="<%= asset_path "hotdocs/icon.svg" %>" alt="A humanized and happy hot dog" height="32" width="32" /></a></p>
+    <p class="reset credits">Built with Rails &amp; <a class="credits__link" href="https://hotdocsrails.com">HotDocs<img class="credits__logo" src="<%= asset_path "hotdocs/icon.svg" %>" alt="A humanized and happy hot dog" height="32" width="32" /></a></p>
   </body>
 </html>

data/lib/hotdocs/markdown.rb CHANGED Viewed

@@ -2,8 +2,6 @@ require "kramdown"
 require "kramdown-parser-gfm"
 require "rouge"
-require_relative "kramdown_alerts"
 class MarkdownHandler
   def call(template, source)
     # If the template contains a `fetcher`, do not allow Rails to cache the page.
@@ -27,7 +25,7 @@ class MarkdownHandler
       .new
       .call(template, source)
       .split(";")
-      .grep(/content_for.*\(.*:/)
+      .grep(/@output_buffer.append=\(\scontent_for.*\(.*:/)
     <<~STRING
       #{content_fors.join(";")}

data/lib/hotdocs/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Hotdocs
-  VERSION = "0.4.0"
+  VERSION = "0.7.0"
 end

data/lib/install/install.rb CHANGED Viewed

@@ -60,11 +60,15 @@ create_file(Pathname(destination_root).join("app/views/layouts/hotdocs.html.erb"
     <%= content_for(:title, "HotDocs") unless content_for?(:title) %>
     <meta name="viewport" content="width=device-width,initial-scale=1">
     <%= stylesheet_link_tag "hotdocs/application" %>
-    <%= stylesheet_link_tag "hotdocs/base" %>
+    <%= stylesheet_link_tag "hotdocs/custom" %>
     <%= stylesheet_link_tag "hotdocs/rouge" %>
     <%= javascript_importmap_tags "hotdocs" %>
   <% end %>
+  <%= content_for(:announcement) do %>
+    <div class="announcement">This is an announcement at the top of the page</div>
+  <% end if false %>
   <%= render template: "layouts/hotdocs/application" %>
 FILE
@@ -110,7 +114,7 @@ create_file(Pathname(destination_root).join("app/helpers/hotdocs_helper.rb"), <<
       ]
     end
-    # { label: "", url: *_path, children: [], expanded: false/true }
+    # { label: String, url?: [String, nil], children?: Array, expanded: Boolean }
     def menu_items
       [
         { label: "Welcome", url: hotdocs_path },
@@ -153,19 +157,37 @@ create_file(Pathname(destination_root).join("app/helpers/hotdocs_helper.rb"), <<
     def fetcher_host
       "http://127.0.0.1:3000"
     end
+    def search_provider
+      "lunr"
+    end
   end
 FILE
 empty_directory "app/assets/stylesheets/hotdocs"
-create_file(Pathname(destination_root).join("app/assets/stylesheets/hotdocs/base.css"), <<~FILE)
+create_file(Pathname(destination_root).join("app/assets/stylesheets/hotdocs/custom.css"), <<~FILE)
   :root {
     --docs-code-background-color: #eee;
     --docs-code-border-color: #00000022;
     --docs-text-color: #1c1e21;
   }
-  [data-theme=dark]:root {
+  @media (prefers-color-scheme: dark) {
+    :root {
+      --docs-code-background-color: #2b2b2b;
+      --docs-code-border-color: #ffffff22;
+      --docs-text-color: #e3e1de;
+    }
+  }
+  :root:has(#scheme-light:checked) {
+    --docs-code-background-color: #eee;
+    --docs-code-border-color: #00000022;
+    --docs-text-color: #1c1e21;
+  }
+  :root:has(#scheme-dark:checked) {
     --docs-code-background-color: #2b2b2b;
     --docs-code-border-color: #ffffff22;
     --docs-text-color: #e3e1de;
@@ -294,5 +316,4 @@ empty_directory "app/assets/builds"
 keep_file "app/assets/builds"
 if Pathname(destination_root).join(".gitignore").exist?
   append_to_file(".gitignore", %(\n/app/assets/builds/*\n!/app/assets/builds/.keep\n))
-  append_to_file(".gitignore", %(\n/node_modules/\n))
 end

data/lib/tasks/hotdocs_tasks.rake CHANGED Viewed

@@ -3,40 +3,45 @@ namespace :hotdocs do
   task :install do
     location = File.expand_path("../install/install.rb", __dir__)
     system("#{RbConfig.ruby} ./bin/rails app:template LOCATION=#{location}")
-    # Needed for hotdocs:index to find the generated ::HotdocsController
+    # Needed for hotdocs:lunr:index to find the generated ::HotdocsController
     Rails.application.reloader.reload!
-    Rake::Task["hotdocs:index"].invoke
+    Rake::Task["hotdocs:lunr:index"].invoke
   end
-  desc "Build search data"
-  task index: :environment do
-    path = Rails.root.join("app/assets/builds/search_data.json")
-    # Propshaft caches the `@load_path`s. Rendering data goes through Propshaft
-    # because of the assets, so the file must exist before rendering.
-    File.write(path, "")
-    data = render_search_data.call.to_json
-    File.write(path, data)
+  namespace :lunr do
+    desc "Prepare lunr data"
+    task index: :environment do
+      helper = Object.new.extend(Hotdocs::ApplicationHelper)
+      next if helper.search_provider != "lunr"
+      path = Rails.root.join("app/assets/builds/lunr_data.json")
+      # Propshaft caches the `@load_path`s. Rendering data goes through Propshaft
+      # because of the assets, so the file must exist before rendering.
+      File.write(path, "")
+      data = render_lunr_data.call.to_json
+      File.write(path, data)
+    end
   end
 end
 if Rake::Task.task_defined?("assets:precompile")
-  Rake::Task["assets:precompile"].enhance([ "hotdocs:index" ])
+  Rake::Task["assets:precompile"].enhance([ "hotdocs:lunr:index" ])
 end
 if Rake::Task.task_defined?("test:prepare")
-  Rake::Task["test:prepare"].enhance([ "hotdocs:index" ])
+  Rake::Task["test:prepare"].enhance([ "hotdocs:lunr:index" ])
 elsif Rake::Task.task_defined?("spec:prepare")
-  Rake::Task["spec:prepare"].enhance([ "hotdocs:index" ])
+  Rake::Task["spec:prepare"].enhance([ "hotdocs:lunr:index" ])
 elsif Rake::Task.task_defined?("db:test:prepare")
-  Rake::Task["db:test:prepare"].enhance([ "hotdocs:index" ])
+  Rake::Task["db:test:prepare"].enhance([ "hotdocs:lunr:index" ])
 end
-def render_search_data
+def render_lunr_data
   renderer = Class.new(::HotdocsController) do
     include Hotdocs::ApplicationHelper
     def call
-      with_no_view_annotations { render_search_data }
+      with_no_view_annotations { render_lunr_data }
     end
     private
@@ -49,7 +54,7 @@ def render_search_data
       Rails.application.config.action_view.annotate_rendered_view_with_filename = annotate
     end
-    def render_search_data
+    def render_lunr_data
       pages = pages_from(menu_items)
       $stderr.puts "Indexing #{pages.size} pages:"
       render_pages(pages).tap { $stderr.puts }
@@ -66,12 +71,12 @@ def render_search_data
     def pages_from(menu_items, parent = "Docs")
       menu_items
-        .filter { _1.fetch(:url).start_with?("/") }
         .flat_map do |item|
-          current = { title: item.fetch(:label), parent: parent, url: item.fetch(:url) }
+          current = { title: item.fetch(:label), parent: parent, url: item.fetch(:url, "") }
           children = pages_from(item.fetch(:children, []), item.fetch(:label))
           [ current ] + children
         end
+        .filter { _1.fetch(:url).start_with?("/") }
     end
     def render_path(path)

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hotdocs
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.7.0
 platform: ruby
 authors:
 - 3v0k4
@@ -79,7 +79,8 @@ files:
 - app/assets/images/hotdocs/icon.svg
 - app/assets/javascript/controllers/accordion_controller.js
 - app/assets/javascript/controllers/fetcher_controller.js
-- app/assets/javascript/controllers/search_controller.js
+- app/assets/javascript/controllers/input_cycler_controller.js
+- app/assets/javascript/controllers/lunr_controller.js
 - app/assets/javascript/controllers/sidenav_controller.js
 - app/assets/javascript/controllers/toc_controller.js
 - app/assets/stylesheets/hotdocs/application.css
@@ -90,7 +91,6 @@ files:
 - config/importmap.rb
 - lib/hotdocs.rb
 - lib/hotdocs/engine.rb
-- lib/hotdocs/kramdown_alerts.rb
 - lib/hotdocs/markdown.rb
 - lib/hotdocs/version.rb
 - lib/install/install.rb