thang/notes
1
0
Fork 0
mirror of https://github.com/thangisme/notes.git synced 2025-01-03 00:47:03 -05:00
Code Issues Projects Releases Wiki Activity

Added search.button configuration

Browse Source 
Improved documentation for search configurations
This commit is contained in:
Silvio Giebl 2019-12-29 21:30:44 +01:00
parent 2ef0029068
commit 82b3f15443
5 changed files with 43 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
_config.yml
View File

@ -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
preview_words_before: 5 # Maximum amount of words to display before a matched word in the preview
preview_words_after: 10 # Maximum amount of words to display after a matched word in the preview
rel_url: false # Include the relative url in the search: true (default) or false
tokenizer_separator: /[\s/]+/ # Enable support for hyphenated search words
# Split documents into sections that can be individually searched
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of words to display before a matched word in the preview
# 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

2
_layouts/default.html
View File

@ -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 %}

2
assets/js/just-the-docs.js
View File

@ -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');

2
assets/js/zzzz-search-data.json
View File

@ -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 -%}

23
docs/configuration.md
View File

@ -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
preview_words_before: 5 # Maximum amount of words to display before a matched word in the preview
preview_words_after: 10 # Maximum amount of words to display after a matched word in the preview
rel_url: false # Include the relative url in the search: true (default) or false
tokenizer_separator: /[\s/]+/ # Enable support for hyphenated search words
# Split documents into sections that can be individually searched
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of words to display before a matched word in the preview
# 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