Removed unnecessary rake command and files

Improved search documentation
This commit is contained in:
Silvio Giebl
2020-03-25 00:23:17 +01:00
parent 672de29f2e
commit f5e6573e16
6 changed files with 75 additions and 90 deletions

View File

@@ -19,18 +19,19 @@ baseurl: "/just-the-docs" # the subpath of your site, e.g. /blog
url: "https://pmarsceill.github.io" # the base hostname & protocol for your site, e.g. http://example.com
permalink: pretty
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "lib/", "bin/", "README.md", "Rakefile"]
exclude: ["node_modules/", "*.gemspec", "*.gem", "Gemfile", "Gemfile.lock", "package.json", "package-lock.json", "script/", "LICENSE.txt", "README.md"]
# Set a path/url to a logo that will be displayed instead of the title
#logo: "/assets/images/just-the-docs.png"
# Enable or disable the site search
# Supports true (default) or false
search_enabled: true
search:
# Split documents into sections that can be individually searched
# Split pages into sections that can be searched individually
# Supports 1 - 6, default: 2
heading_level: 2
# Maximum amount of previews to display
# Maximum amount of previews per search result
# Default: 3
previews: 3
# Maximum amount of words to display before a matched word in the preview
@@ -39,12 +40,13 @@ search:
# 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
# Set the search token separator
# Default: /[\s\-/]+/
# Example: enable support for hyphenated search words
tokenizer_separator: /[\s/]+/
# Display the relative url in search results
# 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