Added search.button configuration

Improved documentation for search configurations

_config.yml

@@ -27,11 +27,24 @@ exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "pac
 # Enable or disable the site search
 search_enabled: true
 search:
-  heading_level: 2              # Split documents into sections that can be individually searched
+  # Split documents into sections that can be individually searched
-  preview_words_before: 5       # Maximum amount of words to display before a matched word in the preview
+  # Supports 1 - 6, default: 2
-  preview_words_after: 10       # Maximum amount of words to display after a matched word in the preview
+  heading_level: 2
-  rel_url: false                # Include the relative url in the search: true (default) or false
+  # Maximum amount of words to display before a matched word in the preview
-  tokenizer_separator: /[\s/]+/ # Enable support for hyphenated search words
+  # Default: 5
+  preview_words_before: 5
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 10
+  # Include the relative url in the search
+  # Supports true (default) or false
+  rel_url: false
+  # Enable support for hyphenated search words
+  # Default: /[\s\-/]+/
+  tokenizer_separator: /[\s/]+/
+  # Enable or disable the search button
+  # Supports true or false (default)
+  button: true
 
 # Enable or disable heading anchors
 heading_anchors: true

_layouts/default.html

@@ -115,9 +115,11 @@ layout: table_wrappers
   </div>
 
   {% if site.search_enabled != false %}
+    {% if site.search.button %}
       <a href="#" id="search-button" class="search-button">
         <svg viewBox="0 0 24 24" class="icon"><use xlink:href="#svg-search"></use></svg>
       </a>
+    {% endif %}
 
     <div class="search-overlay"></div>
   {% endif %}

assets/js/just-the-docs.js

@@ -51,7 +51,7 @@ function initNav() {
     }
   });
 
-  {% if site.search_enabled != false -%}
+  {% if site.search_enabled != false and site.search.button -%}
   const searchInput = document.getElementById('search-input');
   const searchButton = document.getElementById('search-button');
 

assets/js/zzzz-search-data.json

@@ -6,7 +6,7 @@ permalink: /assets/js/search-data.json
   {% for page in site.html_pages %}
     {%- if page.title and page.search_exclude != true -%}
       {%- assign page_content = page.content -%}
-      {%- assign heading_level = site.search.heading_level | default: 1 -%}
+      {%- assign heading_level = site.search.heading_level | default: 2 -%}
       {%- for j in (2..heading_level) -%}
         {%- assign tag = '<h' | append: j -%}
         {%- assign closing_tag = '</h' | append: j -%}

docs/configuration.md

@@ -37,11 +37,24 @@ logo: "/assets/images/just-the-docs.png"
 search_enabled: true
 
 search:
-  heading_level: 2              # Split documents into sections that can be individually searched
+  # Split documents into sections that can be individually searched
-  preview_words_before: 5       # Maximum amount of words to display before a matched word in the preview
+  # Supports 1 - 6, default: 2
-  preview_words_after: 10       # Maximum amount of words to display after a matched word in the preview
+  heading_level: 2
-  rel_url: false                # Include the relative url in the search: true (default) or false
+  # Maximum amount of words to display before a matched word in the preview
-  tokenizer_separator: /[\s/]+/ # Enable support for hyphenated search words
+  # Default: 5
+  preview_words_before: 5
+  # Maximum amount of words to display after a matched word in the preview
+  # Default: 10
+  preview_words_after: 10
+  # Include the relative url in the search
+  # Supports true (default) or false
+  rel_url: false
+  # Enable support for hyphenated search words
+  # Default: /[\s\-/]+/
+  tokenizer_separator: /[\s/]+/
+  # Enable or disable the search button
+  # Supports true or false (default)
+  button: true
 ```
 
 ## Aux links