generated from MDLutoronto/jtd-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_config.yml
More file actions
208 lines (202 loc) · 7.96 KB
/
_config.yml
File metadata and controls
208 lines (202 loc) · 7.96 KB
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
## Site settings
title: "Qualitative Data Analysis Software Options"
description: "Workshops and guides from the Map & Data Library, University of Toronto"
url: "https://MDLutoronto.github.io/qualitative-data-analysis-software-options" # change the slug to the repo's name ('jtd-template' in this case)
repository: "MDLutoronto/qualitative-data-analysis-software-options" # for github-metadata
## Navigation footer logos and links
## Change it only if you want to use different logos or links
## Logos should be placed in the /assets/images/ directory, or you can use an external image link
nav_footer_logo_bottom: "/assets/images/UTL.png"
nav_footer_logo_bottom_href: "https://library.utoronto.ca/"
nav_footer_logo_top: "/assets/images/mdl_full_logo.png"
nav_footer_logo_top_href: "https://mdl.library.utoronto.ca/"
## License information
## If left empty, a default Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International license will be used
license_name: "Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International"
license_url: "https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en" # link to the license
license_image_url: "https://mirrors.creativecommons.org/presskit/buttons/88x31/svg/by-nc-sa.svg" # image Link or image file path for the license
# # Aux links for the upper right search bar (optional)
# # Uncomment if you want to have the aux links (right side of the top nav bar)
# aux_links:
# "Map & Data Library":
# - "https://mdl.library.utoronto.ca/"
# "U of T Libraries":
# - "https://library.utoronto.ca/"
## Workshop series name to be displayed in the footer (optional)
# workshop_series_name: "Map & Data Library Workshop Series"
## Custom footer content (HTML is allowed)
## If left empty, a default credit line will be used
# footer_content: '<small><pre>Guide created by <a target="_blank" rel="noopener noreferrer" href="https://mdl.library.utoronto.ca/">Map & Data Library, University of Toronto</a>.</small></pre>'
#################################################
# 🚨 DANGER ZONE 🚨
# ONLY CHANGE BELOW THIS LINE IF YOU KNOW WHAT YOU ARE DOING
#################################################
source: docs/
baseurl: "" # the subpath of your site, e.g. /blog
# Link for the site title in the sidebar; set to "/" for homepage
title_link: "https://mdlutoronto.github.io/tutorials-search/"
# # Makes Aux links open in a new tab. Default is false
aux_links_new_tab: true
# # External navigation links that appear in the sidebar and shows after all the sub-pages
# # Each link must have a title and a url
nav_external_links:
- title: "Map & Data Library"
url: https://mdl.library.utoronto.ca/
opens_in_new_tab: true # Optional, defaults to false
# - title: "U of T Libraries"
# url: https://library.utoronto.ca/
# opens_in_new_tab: true # Optional, defaults to false
# # Color scheme currently only supports "dark", "light"/nil (default), or a custom scheme that you define
color_scheme: mdl
# # Remote theme
remote_theme: "MDLutoronto/jtd-theme"
permalink: pretty
defaults:
- scope:
path: "docs" # an empty string here means all files in the project
type: "pages"
values:
layout: "default"
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/
# Set a path/url to a logo that will be displayed instead of the title
#logo: "/assets/images/just-the-docs.png"
# 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: 2
# Maximum amount of words to display before a matched word in the preview
# Default: 5
preview_words_before: 3
# Maximum amount of words to display after a matched word in the preview
# Default: 10
preview_words_after: 3
# 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"
# For copy button on code
enable_copy_code_button: true
# By default, consuming the theme as a gem leaves mermaid disabled; it is opt-in
mermaid:
# Version of mermaid library
# Pick an available version from https://cdn.jsdelivr.net/npm/mermaid/
version: "9.1.6"
# Put any additional configuration, such as setting the theme, in _includes/mermaid_config.js
# See also docs/ui-components/code
# To load mermaid from a local library, also use the `path` key to specify the location of the library; e.g.
# for (v10+):
# path: "/assets/js/mermaid.esm.min.mjs"
# for (<v10):
# path: "/assets/js/mermaid.min.js"
# 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/`.
# Enable or disable heading anchors
heading_anchors: true
# Enable or disable the side/mobile menu globally
# Nav menu can also be selectively enabled or disabled using page variables or the minimal layout
nav_enabled: true
# Sort order for navigation links
# nav_sort: case_insensitive # default, equivalent to nil
nav_sort: case_sensitive # Capital letters sorted before lowercase
# Show navigation error report
nav_error_report: true # default is false/nil.
liquid:
error_mode: strict
strict_filters: true
# Footer content
# appears at the bottom of every page's main content
# Back to top link
back_to_top: true
back_to_top_text: "Back to top"
# Footer last edited timestamp
last_edit_timestamp: false # Keep this be `false`, since it's set inside the footer_custom.html ; use `last_modified_date` in the page's front matter instead
# # Footer "Edit this page on GitHub" link text
# gh_edit_link: true # show or hide edit this page link
# gh_edit_link_text: "Edit this page on GitHub"
# gh_edit_repository: "https://github.com/just-the-docs/just-the-docs" # the github URL for your repo
# gh_edit_branch: "main" # the branch that your docs is served from
# # gh_edit_source: docs # the source that your files originate from
# gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
callouts_level: quiet # or loud
callouts:
highlight:
color: yellow
important:
title: Important
color: blue
new:
title: New
color: green
note:
title: Note
color: purple
warning:
title: Warning
color: red
# Google Analytics Tracking (optional)
# Supports a CSV of tracking ID strings (eg. "UA-1234567-89,G-1AB234CDE5")
# Note: the main Just the Docs site does *not* use Google Analytics.
# ga_tracking: UA-2709176-10,G-5FG1HLH3XQ
# ga_tracking_anonymize_ip: true # Use GDPR compliant Google Analytics settings (true/nil by default)
plugins:
- jekyll-seo-tag
- jekyll-github-metadata
- jekyll-include-cache
- jekyll-sitemap
# - jekyll-toc
- jekyll-remote-theme
kramdown:
syntax_highlighter_opts:
block:
line_numbers: false
compress_html:
clippings: all
comments: all
endings: all
startings: []
blanklines: false
profile: false
# ignore:
# envs: all
sass:
quiet_deps: true # https://github.com/just-the-docs/just-the-docs/issues/1541
silence_deprecations: ["import"] # https://github.com/just-the-docs/just-the-docs/issues/1607