-
Notifications
You must be signed in to change notification settings - Fork 30
/
Copy pathmkdocs.yml
200 lines (188 loc) · 6.44 KB
/
mkdocs.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
site_name: PurrBot Documentation
site_description: 'API-Documentation and Wiki of *Purr*'
site_author: 'Andre_601'
site_url: 'https://docs.purrbot.site'
copyright: |
Docs made with
<img alt="❤" class="twemoji heart md-footer-custom-text" src="https://twemoji.maxcdn.com/v/latest/svg/2764.svg" title="love">
and available under the
<a href="https://github.com/purrbot-site/Docs/blob/master/LICENSE" target="_blank" rel="nofollow">MIT-License</a>.<br>
<a href="#__consent">Change cookie settings</a>
docs_dir: docs/
repo_name: purrbot-site/PurrBot
repo_url: https://github.com/purrbot-site/PurrBot
edit_uri: https://github.com/purrbot-site/Docs/edit/master/docs
nav:
- index.md
- API:
- api/index.md
- Bot:
- bot/index.md
- bot/commands.md
- bot/faq.md
- bot/selfhosting.md
- Welcome-System:
- bot/welcome-channel.md
- bot/welcome-images.md
- Contributing:
- contribute/index.md
- contribute/formatting-help.md
- Translations:
- contribute/translate/index.md
- contribute/translate/translate-docs.md
- credits/index.md
- Legal:
- legal/index.md
- legal/bot.md
- legal/api.md
- legal/website.md
theme:
name: 'material'
custom_dir: 'theme'
logo: 'assets/img/logo.png'
favicon: 'assets/img/logo.png'
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: cyan
accent: blue
toggle:
icon: octicons/sun-24
name: "Switch to Dark Mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: cyan
accent: blue
toggle:
icon: octicons/moon-24
name: "Switch to Light Mode"
features:
- navigation.indexes
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.top
- content.code.annotate
- content.tooltips
icon:
repo: fontawesome/brands/square-github
admonition:
note: octicons/pencil-16
abstract: octicons/multi-select-16
info: octicons/info-16
tip: octicons/rocket-16
success: octicons/check-circle-16
question: octicons/question-16
warning: octicons/stop-16
failure: octicons/x-circle-16
danger: octicons/alert-16
bug: octicons/bug-16
example: octicons/list-unordered-16
quote: octicons/comment-16
watch:
- theme
extra_css:
- 'assets/css/extra.css'
extra:
consent:
title: Cookie Consent
description: >
We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for.
With your consent, you're helping us to make our documentation better.
social:
- icon: 'simple/patreon'
link: 'https://patreon.com/andre_601'
- icon: 'simple/github'
link: 'https://github.com/purrbot-site'
- icon: 'material/twitter'
link: 'https://twitter.com/TruePurrBot'
- icon: 'simple/mastodon'
link: 'https://botsin.space/@purrbot'
translate:
missing_translation: 'This page has not yet been translated.'
not_translatable: 'This page cannot be translated and is therefore only available in English.'
footer: |
Build using <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>,
<a href="https://squidfunk.github.io/mkdocs-material" target="_blank" rel="noopener">Material for MkDocs</a> and
<a href="https://facelessuser.github.io/pymdown-extensions/" target="_blank" rel="noopener">Pymdown Extensions</a>.
plugins:
- search
- i18n:
docs_structure: folder
languages:
- locale: en
default: true
name: English
build: true
- locale: de_CH
name: Deutsch (Schweiz)
build: true
site_name: PurrBot Dokumentation
site_description: 'API-Dokumentation und Wiki von *Purr*'
copyright: |
Dokumentation mit
<img alt="❤" class="twemoji heart md-footer-custom-text" src="https://twemoji.maxcdn.com/v/latest/svg/2764.svg" title="Liebe">
gemacht und unter der
<a href="https://github.com/purrbot-site/Docs/blob/master/LICENSE" target="_blank" rel="nofollow">MIT-Lizenz</a> verfügbar.<br>
<a href="#__consent">Cookie-Einstellungen verwalten</a>
extra:
consent:
title: Cookie Zustimmung
description: >
Wir verwenden cookies um deine wiederholten Besuche und Einstellungen zu erkennen, aber auch um die Wirksamkeit unserer Dokumentation und ob Benutzer finden nach was sie suchen zu messen.
Mit deiner Zustimmung hilfst du uns, unsere Dokumentation zu verbessern.
translate:
missing_translation: 'Diese Seite wurde noch nicht übersetzt.'
not_translatable: 'Diese Seite kann nicht übersetzt werden und ist darum nur auf Englisch verfügbar.'
footer: |
Erstellt mit <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a>,
<a href="https://squidfunk.github.io/mkdocs-material" target="_blank" rel="noopener">Material for MkDocs</a> und
<a href="https://facelessuser.github.io/pymdown-extensions/" target="_blank" rel="noopener">Pymdown Extensions</a>.
nav_translations:
# Welcome system
Welcome-System: Willkommenssystem
# Contributing
Contributing: Mitmachen
Translations: Übersetzungen
# Legal
Legal: Rechtliches
hooks:
- theme/.hooks/badges.py
- theme/.hooks/theme_overrides_manager.py
- theme/.hooks/language_flags.py
- theme/.hooks/api_docs_gen.py
markdown_extensions:
- attr_list
- toc:
permalink: true
- meta
- md_in_html
- pymdownx.superfences
- pymdownx.magiclink:
repo_url_shortener: true
repo_url_shorthand: true
social_url_shorthand: true
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight
- pymdownx.snippets:
base_path:
- theme/.snippets
- pymdownx.blocks.admonition:
types:
- note
- abstract
- info
- tip
- success
- question
- warning
- failure
- danger
- bug
- example
- quote
- pymdownx.blocks.details:
- pymdownx.blocks.tab:
alternate_style: true