Skip to content

Commit a32c9fd

Browse files
committed
Updated just the docs and mermaid
Adds additional config settings even though most are left on default
1 parent 9087591 commit a32c9fd

File tree

1 file changed

+33
-2
lines changed

1 file changed

+33
-2
lines changed

docs/_config.yml

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
title: TIMDEX API Documentation
22
description: MIT Libraries TIMDEX API Documentation
33

4-
remote_theme: just-the-docs/just-the-docs@v0.4.1
4+
remote_theme: just-the-docs/just-the-docs@v0.5.4
55
plugins:
66
- "jekyll-remote-theme"
77
- "jekyll-seo-tag"
@@ -11,10 +11,41 @@ color_scheme: dark
1111
exclude:
1212
- architecture-decisions
1313

14+
baseurl: ""
15+
# Enable or disable the site search
16+
# Supports true (default) or false
17+
search_enabled: true
18+
search:
19+
# Split pages into sections that can be searched individually
20+
# Supports 1 - 6, default: 2
21+
heading_level: 2
22+
# Maximum amount of previews per search result
23+
# Default: 3
24+
previews: 3
25+
# Maximum amount of words to display before a matched word in the preview
26+
# Default: 5
27+
preview_words_before: 5
28+
# Maximum amount of words to display after a matched word in the preview
29+
# Default: 10
30+
preview_words_after: 10
31+
# Set the search token separator
32+
# Default: /[\s\-/]+/
33+
# Example: enable support for hyphenated search words
34+
tokenizer_separator: /[\s/]+/
35+
# Display the relative url in search results
36+
# Supports true (default) or false
37+
rel_url: true
38+
# Enable or disable the search button that appears in the bottom right corner of every page
39+
# Supports true or false (default)
40+
button: false
41+
42+
# For copy button on code
43+
enable_copy_code_button: true
44+
1445
nav_external_links:
1546
- title: Reference
1647
url: ./reference
1748
hide_icon: false # set to true to hide the external link icon - defaults to false
1849

1950
mermaid:
20-
version: "9.3.0"
51+
version: "10.3.1"

0 commit comments

Comments
 (0)