153 lines
3.9 KiB
YAML
153 lines
3.9 KiB
YAML
title: OpenSearch documentation
|
|
description: >- # this means to ignore newlines until "baseurl:"
|
|
Documentation for OpenSearch, the Apache 2.0 search, analytics, and visualization suite with advanced security, alerting, SQL support, automated index management, deep performance analysis, and more.
|
|
baseurl: "/docs" # the subpath of your site, e.g. /blog
|
|
url: "https://opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com
|
|
permalink: /:path/
|
|
|
|
opensearch_version: 1.0.0
|
|
opensearch_major_minor_version: 1.0
|
|
|
|
# Build settings
|
|
markdown: kramdown
|
|
remote_theme: pmarsceill/just-the-docs@v0.3.3
|
|
|
|
# Kramdown settings
|
|
kramdown:
|
|
toc_levels: 2..3
|
|
|
|
logo: "/assets/images/logo.svg"
|
|
|
|
# Aux links for the upper right navigation
|
|
aux_links:
|
|
|
|
color_scheme: opensearch
|
|
|
|
# Define Jekyll collections
|
|
collections:
|
|
# Define a collection named "tests", its documents reside in the "_tests" directory
|
|
upgrade-to:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
opensearch:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
dashboards:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
security-plugin:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
search-plugins:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
im-plugin:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
monitoring-plugins:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
clients:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
troubleshoot:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
external_links:
|
|
permalink: /:collection/:path/
|
|
output: true
|
|
|
|
just_the_docs:
|
|
# Define the collections used in the theme
|
|
collections:
|
|
upgrade-to:
|
|
name: Upgrade to OpenSearch
|
|
# nav_exclude: true
|
|
nav_fold: true
|
|
# search_exclude: true
|
|
opensearch:
|
|
name: OpenSearch
|
|
nav_fold: true
|
|
dashboards:
|
|
name: OpenSearch Dashboards
|
|
nav_fold: true
|
|
security-plugin:
|
|
name: Security plugin
|
|
nav_fold: true
|
|
search-plugins:
|
|
name: Search plugins
|
|
nav_fold: true
|
|
im-plugin:
|
|
name: Index management plugin
|
|
nav_fold: true
|
|
monitoring-plugins:
|
|
name: Monitoring plugins
|
|
nav_fold: true
|
|
clients:
|
|
name: Clients and tools
|
|
nav_fold: true
|
|
troubleshoot:
|
|
name: Troubleshooting
|
|
nav_fold: true
|
|
external_links:
|
|
name: External links
|
|
|
|
|
|
# Enable or disable the site search
|
|
# Supports true (default) or false
|
|
search_enabled: true
|
|
|
|
search:
|
|
# Split pages into sections that can be searched individually
|
|
# Supports 1 - 6, default: 2
|
|
heading_level: 2
|
|
# Maximum amount of previews per search result
|
|
# Default: 3
|
|
previews: 3
|
|
# 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
|
|
# 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: true
|
|
# Enable or disable the search button that appears in the bottom right corner of every page
|
|
# Supports true or false (default)
|
|
button: false
|
|
|
|
# Google Analytics Tracking (optional)
|
|
# e.g, UA-1234567-89
|
|
ga_tracking: G-BQV14XK08F
|
|
|
|
# Disable the just-the-docs theme anchor links in favor of our custom ones
|
|
# See _includes/head_custom.html
|
|
heading_anchors: false
|
|
|
|
# Adds on-hover anchor links to h2-h6
|
|
anchor_links: true
|
|
|
|
footer_content:
|
|
|
|
plugins:
|
|
- jekyll-remote-theme
|
|
- jekyll-redirect-from
|
|
|
|
# Exclude from processing.
|
|
# The following items will not be processed, by default. Create a custom list
|
|
# to override the default setting.
|
|
exclude:
|
|
- Gemfile
|
|
- Gemfile.lock
|
|
- node_modules
|
|
- vendor/bundle/
|
|
- vendor/cache/
|
|
- vendor/gems/
|
|
- vendor/ruby/
|
|
- README.md
|