mirror of
https://github.com/muraenateam/muraena.git
synced 2026-01-23 02:24:05 +00:00
78 lines
No EOL
2.1 KiB
YAML
78 lines
No EOL
2.1 KiB
YAML
title: Muraena docs
|
|
plugins:
|
|
- jekyll-relative-links
|
|
relative_links:
|
|
enabled: true
|
|
collections: true
|
|
remote_theme: just-the-docs/just-the-docs
|
|
markdown: kramdown
|
|
enable_copy_code_button: true
|
|
search_enabled: true
|
|
heading_anchors: true
|
|
color_scheme: dark
|
|
permalink: pretty
|
|
aux_links_new_tab: false
|
|
aux_links:
|
|
"Muraena on GitHub":
|
|
- "https://github.com/muraenateam/muraena"
|
|
nav_external_links:
|
|
- title: Muraena on GitHub
|
|
url: https://github.com/muraenateam/muraena
|
|
back_to_top: true
|
|
back_to_top_text: "Back to top"
|
|
kramdown:
|
|
syntax_highlighter_opts:
|
|
block:
|
|
line_numbers: false
|
|
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
|
|
# Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
|
|
focus_shortcut_key: 'k'
|
|
exclude:
|
|
# from https://github.com/jekyll/jekyll/blob/master/lib/site_template/_config.yml:
|
|
- .sass-cache/
|
|
- .jekyll-cache/
|
|
- gemfiles/
|
|
- Gemfile
|
|
- Gemfile.lock
|
|
- node_modules/
|
|
- vendor/bundle/
|
|
- vendor/cache/
|
|
- vendor/gems/
|
|
- vendor/ruby/
|
|
# specific to the theme website:
|
|
- bin/
|
|
- lib/
|
|
- "*.gemspec"
|
|
- "*.gem"
|
|
- LICENSE.txt
|
|
- package.json
|
|
- package-lock.json
|
|
- Rakefile
|
|
- README.md
|
|
- CODE_OF_CONDUCT.md
|
|
- docker-compose.yml
|
|
- Dockerfile
|
|
# theme test code
|
|
- fixtures/ |