-
Notifications
You must be signed in to change notification settings - Fork 16
/
mkdocs-base.yml
245 lines (225 loc) · 6.77 KB
/
mkdocs-base.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
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
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
# MkDocs configuration for builds with material theme
site_name: Percona Server for MongoDB 4.4
site_description: Documentation
site_author: Percona LLC
copyright: >
<a href="https://www.percona.com/about">Percona LLC</a> and/or its affiliates © 2024 — <a href="#__consent">Cookie Consent</a>
repo_name: percona/psmdb-docs
repo_url: https://github.com/percona/psmdb-docs
edit_uri: edit/4.4/docs/
use_directory_urls: false
# Theme setup
theme:
name: material
logo: _images/percona-logo.svg
favicon: _images/percona-favicon.ico
custom_dir: _resource/overrides/
font:
text: Roboto
code: Roboto Mono
palette:
# Automatic mode based on system preferences
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: percona-light
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
toggle:
icon: material/toggle-switch
name: Switch to light mode
features:
- search.highlight
- search.suggest
- search.share
- navigation.top
- navigation.tracking
- content.tabs.link
- content.action.edit
- content.action.view
- content.code.copy
- content.copy.annotate
extra_css:
- https://unicons.iconscout.com/release/v3.0.3/css/line.css
- https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.4.0/css/font-awesome.min.css
- css/percona.css
- css/nocopy.css
- css/extra.css
- css/design.css
- css/osano.css
extra_javascript:
- js/version-select.js
- js/promptremover.js
markdown_extensions:
abbr: {}
attr_list: {}
toc:
permalink: True
title: On this page
toc_depth: 3
admonition: {}
footnotes: {}
def_list: {} # https://michelf.ca/projects/php-markdown/extra/#def-list
meta: {}
md_in_html: {}
smarty:
{smart_angled_quotes: true}
pymdownx.details: {}
pymdownx.mark: {}
pymdownx.smartsymbols: {}
pymdownx.tabbed:
{alternate_style: true}
pymdownx.tilde: {}
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
pymdownx.highlight:
linenums: false
pymdownx.inlinehilite: {}
pymdownx.snippets:
base_path: ["snippets"]
auto_append:
- services-banner.md
pymdownx.tasklist:
custom_checkbox: true
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- _resource/overrides/.icons
plugins:
# section-index: {}
search:
separator: '[\s\-,:!=\[\]()"/]+|(?!\b)(?=[A-Z][a-z])|\.(?!\d)|&[lg]t;'
git-revision-date-localized:
enable_creation_date: true
enabled: !ENV [ENABLED_GIT_REVISION_DATE, True]
meta-descriptions:
export_csv: false
quiet: false
enable_checks: false
min_length: 50
max_length: 160
macros:
include_yaml:
- 'variables.yml' # Use in markdown as '{{ VAR }}'
# exclude: # Don't process these files
# glob:
# - file.md
with-pdf: # https://github.com/orzih/mkdocs-with-pdf
output_path: '_pdf/PerconaServerforMongoDB-4.4.pdf'
cover_title: 'Server for MongoDB Documentation 4.4'
cover_subtitle: 4.4.29-28 (April 2, 2024)
author: 'Percona Technical Documentation Team'
cover_logo: docs/_images/Percona_Logo_Color.png
debug_html: false
custom_template_path: _resource/templates
enabled_if_env: ENABLE_PDF_EXPORT
mike:
version_selector: true
css_dir: css
javascript_dir: js
canonical_version: null
extra:
version:
provider: mike
# homepage:
# https://docs.percona.com
nav:
- Home: index.md
- 'Feature comparison with MongoDB': comparison.md
- Get started:
- Quickstart guides: 'install/index.md'
- Installation:
- 'System requirements': 'install/system-requirements.md'
- "On Debian and Ubuntu": install/apt.md
- "On RHEL and derivatives": install/yum.md
- "From tarballs": install/tarball.md
- install/source.md
- "Run in Docker": install/docker.md
- connect.md
- crud.md
- what-next.md
- Features:
- Storage:
- "Percona Memory Engine": "inmemory.md"
- Backup:
- "Hot backup": "hot-backup.md"
- backup-cursor.md
- Authentication:
- "Authentication overview": "authentication.md"
- enable-auth.md
- sasl-auth.md
- x509-ldap.md
- kerberos.md
- aws-iam.md
- aws-iam-setup.md
- authorization.md
- ldap-setup.md
- Encryption:
- "Data at rest encryption": "data-at-rest-encryption.md"
- vault.md
- kmip.md
- keyfile.md
- encryption-mode-switch.md
- audit-logging.md
- rate-limit.md
- log-redaction.md
- ngram-full-text-search.md
- Administration:
- "Tune parameters": "set-parameter.md"
- Upgrade:
- "Upgrade from 4.2 to 4.4": "install/upgrade-from-42.md"
- "Upgrade from MongoDB Community": "install/upgrade-from-mongodb.md"
- install/minor-upgrade.md
- install/uninstall.md
- Release notes:
- "Release notes index": release_notes/index.md
- release_notes/4.4.29-28.md
- release_notes/4.4.28-27.md
- release_notes/4.4.27-26.md
- 2023 (versions 4.4.19-19 through 4.4.26-25):
- release_notes/4.4.26-25.md
- release_notes/4.4.25-24.md
- release_notes/4.4.24-23.md
- release_notes/4.4.23-22.md
- release_notes/4.4.22-21.md
- release_notes/4.4.21-20.md
- release_notes/4.4.19-19.md
- 2022 (versions 4.4.12-12 through 4.4.18-18):
- release_notes/4.4.18-18.md
- release_notes/4.4.17-17.md
- release_notes/4.4.16-16.md
- release_notes/4.4.15-15.md
- release_notes/4.4.14-14.md
- release_notes/4.4.13-13.md
- release_notes/4.4.12-12.md
- 2021 (version 4.4.3-5 through 4.4.10-11):
- release_notes/4.4.10-11.md
- release_notes/4.4.9-10.md
- release_notes/4.4.8-9.md
- release_notes/4.4.6-8.md
- release_notes/4.4.5-7.md
- release_notes/4.4.4-6.md
- release_notes/4.4.3-5.md
- 2020 (versions 4.4.0-1 through 4.4.2-4):
- release_notes/4.4.2-4.md
- release_notes/4.4.1-3.md
- release_notes/4.4.1-2.md
- release_notes/4.4.0-1.md
- faq.md
- Reference:
- glossary.md
- telemetry.md
- copyright.md
- trademark-policy.md