forked from swirlai/swirl-search
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path_config.yml
108 lines (94 loc) · 2.92 KB
/
_config.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
# Site settings
title: Swirl Documentation
description: "One search box to find it all"
repository: "swirlai/swirl-search"
url: https://docs.swirl.today
baseurl: "" # the subpath of your site, e.g. /blog
# Set a path/url to a logo that will be displayed instead of the title
logo: "/assets/images/swirl-logo.png"
# Set a path/url to a favicon that will be displayed by the browser
favicon_ico: "/assets/images/favicon.ico"
# Color scheme supports "light" (default) and "dark"
color_scheme: dark
# Heading anchor links appear on hover over h1-h6 tags in page content
heading_anchors: true
# For copy button on code
enable_copy_code_button: true
# External navigation links
nav_external_links:
- title: Swirl on GitHub
url: https://github.com/swirlai/swirl-search
hide_icon: false # set to true to hide the external link icon - defaults to false
- title: Swirl.Today
url: https://swirl.today/
hide_icon: false # set to true to hide the external link icon - defaults to false
nav_external_links_new_tab: true # set to true to open all external links in new tabs
# Aux links for the upper right navigation
aux_links:
"Swirl on GitHub":
- "//github.com/swirlai/swirl-search"
aux_links_new_tab: true # Makes Aux links open in a new tab. Default is false
# Back to top link
back_to_top: true
back_to_top_text: "Back to top"
callouts_level: loud # or quiet
callouts:
highlight:
title: Note
color: yellow
warning:
title: Warning
color: red
# 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: 3
# 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
relative_links:
enabled: true
collections: false
# Build settings
markdown: kramdown
theme: just-the-docs
plugins:
- jekyll-default-layout
- jekyll-sitemap
- jekyll-relative-links
- jemoji
disable_disk_cache: true
exclude:
# Modified 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/
# Kramdown settings
kramdown:
smart_quotes: [apos, apos, quot, quot]