Add client-side search

Author: afh

.gitignore

@@ -1,16 +1,7 @@
-build
-# source/css is generated from custom_theme/sass
+# NOTA BENE: source/css is generated from custom_theme/sass
 source/css
-*.hi
-*.o
-*.html
-site
-_*
-*.org
-snapshot.tar.gz
-*.log
-*.aes
-.DS_Store
+# Files generated during build or development
+build
 result*
-vendor/
-.bundle/
+# Files specific to macOS
+.DS_Store

custom_theme/main.html

@@ -12,18 +12,32 @@
       <aside>
         <a href="https://git.ledger-cli.org/ledger" class="github-corner" aria-label="View source on GitHub"><svg width="80" height="80" viewBox="0 0 250 250" style="fill:#151513; color:#fff; position: absolute; top: 0; border: 0; right: 0;" aria-hidden="true"><title>Fork me on GitHub</title><path d="M0,0 L115,115 L130,115 L142,142 L250,250 L250,0 Z"></path><path d="M128.3,109.0 C113.8,99.7 119.0,89.6 119.0,89.6 C122.0,82.7 120.5,78.6 120.5,78.6 C119.2,72.0 123.4,76.3 123.4,76.3 C127.3,80.9 125.5,87.3 125.5,87.3 C122.9,97.6 130.6,101.9 134.4,103.2" fill="currentColor" style="transform-origin: 130px 106px;" class="octo-arm"></path><path d="M115.0,115.0 C114.9,115.1 118.7,116.5 119.8,115.4 L133.7,101.6 C136.9,99.2 139.9,98.4 142.2,98.6 C133.8,88.0 127.5,74.4 143.8,58.0 C148.5,53.4 154.0,51.2 159.7,51.0 C160.3,49.4 163.2,43.6 171.4,40.1 C171.4,40.1 176.1,42.5 178.8,56.2 C183.1,58.6 187.2,61.8 190.9,65.4 C194.5,69.0 197.7,73.2 200.1,77.6 C213.8,80.2 216.3,84.9 216.3,84.9 C212.7,93.1 206.9,96.0 205.4,96.6 C205.1,102.4 203.0,107.8 198.3,112.5 C181.9,128.9 168.3,122.5 157.7,114.1 C157.9,116.9 156.7,120.9 152.7,124.9 L141.0,136.5 C139.8,137.7 141.6,141.9 141.8,141.8 Z" fill="currentColor" class="octo-body"></path></svg></a>
       </aside>
+
       <header>
         <nav>
         {% if nav|length>1 -%}<ul>
           {% for nav_item in nav -%}
             <li class="{% if nav_item.active %}current{% endif %}"><a href="{{ nav_item.url|url }}">{{ nav_item.title }}</a></li>
           {% endfor -%}
+          {%- block search_button %}
+            {%- if 'search' in config['plugins'] %}<li>{%- include "searchbox.html" %}</li>{%- endif %}
+          {%- endblock %}
         </ul>{% endif -%}
         </nav>
       </header>
       <article>
-      {{ page.content }}
+      {% block content %}
+        {{ page.content }}
+      {% endblock %}
       </article>
     </main>
+    {%- block scripts %}
+    <script>var base_url = '{{ base_url }}';</script>
+    <script src="{{ 'js/theme_extra.js'|url }}" defer></script>
+    <script src="{{ 'js/theme.js'|url }}" defer></script>
+    {%- for path in extra_javascript %}
+      <script src="{{ path }}" defer></script>
+    {%- endfor %}
+  {%- endblock %}
   </body>
 </html>

custom_theme/sass/site.scss

@@ -1,5 +1,18 @@
 @import url("darkmode.css");
 
+.current {
+  font-weight: bold;
+}
+
+div[role=search] {
+  display: inline-block;
+  position:absolute;
+  margin-top: -1em;
+  * {
+    display: inline-block;
+  }
+}
+
 body {
     color:var(--color);
     background:var(--background-color);
@@ -20,7 +33,7 @@ header {
 
     li {
       display:inline-block;
-      margin:0 2em 0 0;
+      margin:0 1.75em 0 0;
     }
 
    a { text-decoration:none; }
@@ -112,7 +125,7 @@ pre {
 
 @media screen and (max-width:765px) {
     header li {
-        margin:1em 2em 0 0;
+        margin:1em 1.75em 0 0;
     }
     nav li:has(a[href="/"]) {
       display:block;

custom_theme/search.html

@@ -0,0 +1,15 @@
+{% extends "main.html" %}
+
+{% block content %}
+
+  <h1 id="search">{% trans %}Search Results{% endtrans %}</h1>
+
+  <form id="content_search" action="search.html">
+    <span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
+    <input name="q" id="mkdocs-search-query" type="text" class="search_input search-query ui-autocomplete-input" placeholder="{% trans %}Search the Docs{% endtrans %}" autocomplete="off" autofocus title="{% trans %}Type search term here{% endtrans %}">
+  </form>
+
+  <div id="mkdocs-search-results" class="search-results" data-no-results-text="{% trans %}No results found{% endtrans %}">
+  </div>
+
+{% endblock %}

custom_theme/searchbox.html

@@ -0,0 +1,5 @@
+<div role="search">
+  <form id ="rtd-search-form" class="wy-form" action="{{ base_url }}/search.html" method="get">
+      <input type="text" name="q" placeholder="{% trans %}Search{% endtrans %}" title="{% trans %}Type search term here{% endtrans %}" />
+  </form>
+</div>

mkdocs.yml

@@ -2,19 +2,20 @@ site_name: ledger
 site_url: https://ledger-cli.org
 site_dir: build
 repo_url: https://github.com/ledger/ledger.github.com/
-theme: readthedocs
 docs_dir: source
 use_directory_urls: false
 
 theme:
   name: null
   custom_dir: 'custom_theme/'
+  include_search_page: true
+  search_index_only: false
 
 nav:
     - ledger: /
-    - Home: index.md
-    - Features: features.md
-    - Docs: docs.md
-    - Download: download.md
-    - Contribute: contribute.md
+    - Home: /index.html
+    - Features: /features.html
+    - Docs: /docs.html
+    - Download: /download.html
+    - Contribute: /contribute.html
     - Wiki: https://wiki.ledger-cli.org

source/404.md

@@ -5,10 +5,10 @@ title: Not Found
 # Page not found
 
 Unfortunately the page you are looking for cannot be found.
-
 Possibly the page moved to another location, or the link or URL was mistyped.
 
-Please use the navigation above to browse other content available on this website.
+To find what you were looking for please use the [search](/search.html) above
+or the navigation on the top of the page to browse other content available on this website.
 
 If you believe there really should be a page under this URL please
 [create an issue](https://git.ledger-cli.org/ledger.github.io/issues/new).