-
Notifications
You must be signed in to change notification settings - Fork 26
/
mkdocs-base.yml
250 lines (233 loc) · 7.05 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
246
247
248
249
# MkDocs base configuration that other conf files will inherit
site_name: Percona Distribution for PostgreSQL
site_description: Documentation
site_author: Percona LLC
copyright: Percona LLC, © 2024
site_url: ""
repo_name: percona/postgresql-docs
repo_url: https://github.com/percona/postgresql-docs
edit_uri: edit/13/docs/
features:
- content.tabs.link
- search.highlight
- navigation.top
- navigation.tracking
- content.tabs.link
- content.action.edit
- content.action.view
- content.code.copy
use_directory_urls: false
# Theme settings
theme:
name: material
logo: _images/postgresql-mark.svg
favicon: _images/postgresql-fav.svg
custom_dir: _resource/overrides/
font:
text: Roboto
code: Roboto Mono
icon:
edit: material/file-edit-outline
view: material/file-eye-outline
#Color schemes
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Color theme set to Automatic. Click to change
- media: "(prefers-color-scheme: light)"
scheme: percona-light
primary: custom
accent: custom
toggle:
icon: material/brightness-7
name: Color theme set to Light Mode. Click to change
- media: "(prefers-color-scheme: dark)"
scheme: percona-dark
primary: custom
accent: custom
toggle:
icon: material/brightness-4
name: Color theme set to Dark Mode. Click to change
# Theme features
features:
- search.highlight
- navigation.top
- navigation.tracking
- content.tabs.link
- content.action.edit
- content.action.view
- content.code.copy
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/version-select.css
- css/extra.css
- css/design.css
- css/osano.css
- css/landing.css
- css/postgresql.css
extra_javascript:
- js/version-select.js
- js/promptremover.js
- js/consent.js
markdown_extensions:
attr_list: {}
toc:
permalink: True
title: On this page
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:
use_pygments: true
pymdownx.inlinehilite: {}
pymdownx.snippets:
base_path: ["snippets"]
auto_append:
- services-banner.md
pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- _resource/.icons
plugins:
section-index: {}
search:
separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
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/PerconaDistributionPostgreSQL-13.pdf'
cover_title: 'Distribution for PostgreSQL Documentation'
cover_subtitle: 13.16 (September 12, 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
postgresrecommended: 16
nav:
- 'Home': 'index.md'
- Get started:
- Quickstart guide: installing.md
- 1. Install:
- Via apt: apt.md
- Via yum: yum.md
- From tarballs: tarball.md
- Run in Docker: docker.md
- enable-extensions.md
- repo-overview.md
- 2. Connect to PostgreSQL: connect.md
- 3. Manipulate data in PostgreSQL: crud.md
- 4. What's next: whats-next.md
- Extensions:
- 'Extensions': extensions.md
- contrib.md
- Percona-authored extensions: percona-ext.md
- third-party.md
- Solutions:
- Overview: solutions.md
- High availability:
- "High availability": "solutions/high-availability.md"
- 'Deploying on Debian or Ubuntu': 'solutions/ha-setup-apt.md'
- 'Deploying on RHEL or derivatives': 'solutions/ha-setup-yum.md'
- solutions/pgbackrest.md
- solutions/ha-test.md
- Backup and disaster recovery:
- "Backup and disaster recovery": "solutions/backup-recovery.md"
- solutions/dr-pgbackrest-setup.md
- Spatial data handling:
- Overview: solutions/postgis.md
- Deployment: solutions/postgis-deploy.md
- Query spatial data: solutions/postgis-testing.md
- Upgrade spatial database: solutions/postgis-upgrade.md
- LDAP authentication:
- ldap.md
- Upgrade:
- "Major upgrade": major-upgrade.md
- minor-upgrade.md
- migration.md
- Troubleshooting guide: troubleshooting.md
- How to: how-to.md
- Uninstall: uninstalling.md
- Release notes:
- "Release notes index": "release-notes.md"
- release-notes-v13.16.md
- release-notes-v13.15.md
- release-notes-v13.14.md
- release-notes-v13.13.upd.md
- release-notes-v13.13.md
- release-notes-v13.12.md
- release-notes-v13.11.md
- release-notes-v13.10.upd.md
- release-notes-v13.10.md
- 2022 (versions 13.6 - 13.9):
- release-notes-v13.9.md
- release-notes-v13.8.md
- release-notes-v13.7.md
- release-notes-v13.6.upd2.md
- release-notes-v13.6.upd.md
- release-notes-v13.6.md
- 2021 (versions 13.2 - 13.5):
- release-notes-v13.5.upd2.md
- release-notes-v13.5.upd.md
- release-notes-v13.5.md
- release-notes-v13.4.upd.md
- release-notes-v13.4.md
- release-notes-v13.3.upd3.md
- release-notes-v13.3.upd2.md
- release-notes-v13.3.upd.md
- release-notes-v13.3.md
- release-notes-v13.2.upd4.md
- release-notes-v13.2.upd3.md
- release-notes-v13.2.upd2.md
- 2020 (versions 13.0 - 13.2):
- release-notes-v13.2.upd.md
- release-notes-v13.2.md
- release-notes-v13.1.md
- release-notes-v13.0.md
- Reference:
- Telemetry: telemetry.md
- Licensing: licensing.md
- Trademark policy: trademark-policy.md