From 2ef0029068e7c96ac83c1bccb1189759037269cc Mon Sep 17 00:00:00 2001 From: Silvio Giebl <silvio.giebl@hivemq.com> Date: Sun, 29 Dec 2019 21:08:15 +0100 Subject: [PATCH] Add documentation for search configurations --- _config.yml | 10 +++++----- docs/configuration.md | 9 ++++++--- 2 files changed, 11 insertions(+), 8 deletions(-) diff --git a/_config.yml b/_config.yml index 470fe5d0..7bd5727f 100644 --- a/_config.yml +++ b/_config.yml @@ -27,11 +27,11 @@ exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "pac # Enable or disable the site search search_enabled: true search: - heading_level: 2 - preview_words_before: 5 - preview_words_after: 10 - rel_url: false - tokenizer_separator: /[\s/]+/ # Set the search token separator for hyphenated-word 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 # Enable or disable heading anchors heading_anchors: true diff --git a/docs/configuration.md b/docs/configuration.md index eb43a086..4c175e85 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -36,9 +36,12 @@ logo: "/assets/images/just-the-docs.png" # Supports true (default) or false search_enabled: true -# Enable support for hyphenated search words: -search_tokenizer_separator: /[\s/]+/ - +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 ``` ## Aux links -- GitLab