opensearch-docs-cn/_config.yml

154 lines
3.9 KiB
YAML
Raw Normal View History

2021-05-05 13:09:47 -04:00
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.
2021-05-07 15:26:57 -04:00
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://docs-beta.opensearch.org" # the base hostname & protocol for your site, e.g. http://example.com
2021-06-10 16:44:37 -04:00
permalink: /:path/
2021-05-05 13:09:47 -04:00
2021-07-09 19:30:46 -04:00
opensearch_version: 1.0.0
2021-05-05 13:09:47 -04:00
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
2021-05-07 12:57:01 -04:00
logo: "/assets/images/logo.svg"
2021-05-05 13:09:47 -04:00
# Aux links for the upper right navigation
aux_links:
"Back to OpenSearch.org":
2021-05-06 16:48:02 -04:00
- "https://opensearch.org"
2021-05-05 13:09:47 -04:00
color_scheme: opensearch
2021-05-28 13:48:19 -04:00
# Define Jekyll collections
collections:
# Define a collection named "tests", its documents reside in the "_tests" directory
upgrade-to:
permalink: /:collection/:path/
output: true
2021-05-28 14:19:18 -04:00
opensearch:
permalink: /:collection/:path/
2021-05-28 13:48:19 -04:00
output: true
2021-05-28 14:19:18 -04:00
dashboards:
permalink: /:collection/:path/
2021-05-28 13:48:19 -04:00
output: true
2021-05-28 15:43:12 -04:00
security-plugin:
permalink: /:collection/:path/
2021-05-28 15:43:12 -04:00
output: true
search-plugins:
permalink: /:collection/:path/
2021-05-28 15:43:12 -04:00
output: true
im-plugin:
permalink: /:collection/:path/
2021-05-28 15:43:12 -04:00
output: true
monitoring-plugins:
permalink: /:collection/:path/
2021-05-28 14:19:18 -04:00
output: true
clients:
permalink: /:collection/:path/
2021-05-28 14:19:18 -04:00
output: true
troubleshoot:
permalink: /:collection/:path/
2021-05-28 13:48:19 -04:00
output: true
external_links:
permalink: /:collection/:path/
2021-05-28 13:48:19 -04:00
output: true
just_the_docs:
# Define the collections used in the theme
collections:
upgrade-to:
name: Upgrade to OpenSearch
2021-05-28 13:48:19 -04:00
# nav_exclude: true
2021-05-28 14:19:18 -04:00
nav_fold: true
2021-05-28 13:48:19 -04:00
# search_exclude: true
opensearch:
name: OpenSearch
nav_fold: true
2021-05-28 14:19:18 -04:00
dashboards:
2021-05-28 13:48:19 -04:00
name: OpenSearch Dashboards
2021-05-28 14:19:18 -04:00
nav_fold: true
2021-05-28 15:43:12 -04:00
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
2021-05-28 14:19:18 -04:00
nav_fold: true
clients:
2021-06-10 12:09:20 -04:00
name: Clients and tools
2021-05-28 14:19:18 -04:00
nav_fold: true
troubleshoot:
2021-05-28 13:48:19 -04:00
name: Troubleshooting
2021-05-28 14:19:18 -04:00
nav_fold: true
2021-05-28 13:48:19 -04:00
external_links:
name: External links
2021-05-05 13:09:47 -04:00
# 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
2021-05-05 13:09:47 -04:00
# 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