Skip to content

Commit 5b3836c

Browse files
kurtshulerkurtshuler
committed
updates to .Gemfile and _config.yml
1 parent ba24bd0 commit 5b3836c

File tree

2 files changed

+121
-2
lines changed

2 files changed

+121
-2
lines changed

‎Gemfile‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ gem "jekyll", "~> 4.4.1" # installed by `gem jekyll`
66
gem "just-the-docs", "0.10.1" # pinned to the current release
77
# gem "just-the-docs" # always download the latest release
88

9-
gem 'jekyll-default-layout' # https://github.com/benbalter/jekyll-default-layout
9+
gem 'jekyll-default-layout' # https://github.com/benbalter/jekyll-default-layout
10+
gem 'jekyll-sitemap' # https://github.com/jekyll/jekyll-sitemap
11+
gem 'jekyll-include-cache' # https://github.com/benbalter/jekyll-include-cache
12+
gem 'jekyll-github-metadata' # https://github.com/jekyll/github-metadata
13+
# gem 'jekyll-seo-tag' # https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/installation.md

‎_config.yml‎

Lines changed: 116 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,119 @@ aux_links:
1212
Template Repository: https://github.com/just-the-docs/just-the-docs-template
1313

1414
plugins:
15-
- jekyll-default-layout
15+
- jekyll-default-layout # https://github.com/benbalter/jekyll-default-layout
16+
- jekyll-sitemap # https://github.com/jekyll/jekyll-sitemap
17+
- jekyll-include-cache # https://github.com/benbalter/jekyll-include-cache
18+
- jekyll-github-metadata # https://github.com/jekyll/github-metadata
19+
# - jekyll-seo-tag # https://github.com/jekyll/jekyll-seo-tag/blob/master/docs/installation.md
20+
21+
# Enable or disable the site search
22+
# Supports true (default) or false
23+
search_enabled: true
24+
search:
25+
# Split pages into sections that can be searched individually
26+
# Supports 1 - 6, default: 2
27+
heading_level: 2
28+
# Maximum amount of previews per search result
29+
# Default: 3
30+
previews: 2
31+
# Maximum amount of words to display before a matched word in the preview
32+
# Default: 5
33+
preview_words_before: 3
34+
# Maximum amount of words to display after a matched word in the preview
35+
# Default: 10
36+
preview_words_after: 3
37+
# Set the search token separator
38+
# Default: /[\s\-/]+/
39+
# Example: enable support for hyphenated search words
40+
tokenizer_separator: /[\s/]+/
41+
# Display the relative url in search results
42+
# Supports true (default) or false
43+
rel_url: true
44+
# Enable or disable the search button that appears in the bottom right corner of every page
45+
# Supports true or false (default)
46+
button: false
47+
# Focus the search input by pressing `ctrl + focus_shortcut_key` (or `cmd + focus_shortcut_key` on macOS)
48+
focus_shortcut_key: "k"
49+
50+
# For copy button on code
51+
enable_copy_code_button: true
52+
53+
# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in
54+
mermaid:
55+
# Version of mermaid library
56+
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
57+
version: "9.1.6"
58+
# Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
59+
# See also docs/ui-components/code
60+
# To load mermaid from a local library, also use the `path` key to specify the location of the library; e.g.
61+
# for (v10+):
62+
# path: "/assets/js/mermaid.esm.min.mjs"
63+
# for (<v10):
64+
# path: "/assets/js/mermaid.min.js"
65+
# Note: copy both `mermaid.esm.min.mjs` (v10+) or `mermaid.min.js` (<v10) and the associated `.map` file from the specified version of `mermaid/dist` to `/assets/js/`.
66+
67+
# Enable or disable heading anchors
68+
heading_anchors: true
69+
70+
# Aux links for the upper right navigation
71+
aux_links:
72+
"Just the Docs on GitHub":
73+
- "https://github.com/just-the-docs/just-the-docs"
74+
75+
# Makes Aux links open in a new tab. Default is false
76+
aux_links_new_tab: false
77+
78+
# Enable or disable the side/mobile menu globally
79+
# Nav menu can also be selectively enabled or disabled using page variables or the minimal layout
80+
nav_enabled: true
81+
82+
# Sort order for navigation links
83+
# nav_sort: case_insensitive # default, equivalent to nil
84+
nav_sort: case_sensitive # Capital letters sorted before lowercase
85+
86+
# External navigation links
87+
nav_external_links:
88+
- title: Just the Docs on GitHub
89+
url: https://github.com/just-the-docs/just-the-docs
90+
91+
# Show navigation error report
92+
nav_error_report: true # default is false/nil.
93+
94+
liquid:
95+
error_mode: strict
96+
strict_filters: true
97+
98+
# Footer content
99+
# appears at the bottom of every page's main content
100+
101+
# Back to top link
102+
back_to_top: true
103+
back_to_top_text: "Back to top"
104+
105+
footer_content: 'Copyright &copy; 2017-2020 Patrick Marsceill. Distributed by an <a href="https://github.com/just-the-docs/just-the-docs/tree/main/LICENSE.txt">MIT license.</a> <a href="https://www.netlify.com/">This site is powered by Netlify.</a>'
106+
107+
# Footer last edited timestamp
108+
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
109+
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
110+
111+
# Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
112+
color_scheme: nil
113+
114+
callouts_level: quiet # or loud
115+
callouts:
116+
highlight:
117+
color: yellow
118+
important:
119+
title: Important
120+
color: blue
121+
new:
122+
title: New
123+
color: green
124+
note:
125+
title: Note
126+
color: purple
127+
warning:
128+
title: Warning
129+
color: red
130+

0 commit comments

Comments
 (0)