-
Notifications
You must be signed in to change notification settings - Fork 19
/
mkdocs.yml
210 lines (199 loc) · 8.78 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
201
202
203
204
205
206
207
208
209
210
site_name: WoltLab Suite Documentation
theme:
name: material
language: en
custom_dir: overrides
logo: assets/logo.png
favicon: assets/default.favicon.ico
palette:
primary: teal
font: false
features:
- navigation.tracking
copyright: Copyright © 2020 WoltLab GmbH
site_url: https://docs.woltlab.com/
repo_url: https://github.com/WoltLab/docs.woltlab.com/
edit_uri: edit/6.1/docs/
nav:
- 'Getting Started': 'getting-started.md'
- 'PHP API':
- 'Pages': 'php/pages.md'
- 'Database Objects': 'php/database-objects.md'
- 'Database Access': 'php/database-access.md'
- 'Exceptions': 'php/exceptions.md'
- 'API':
- 'ACP Dashboard Boxes': 'php/api/acp_dashboard_boxes.md'
- 'Caches':
- 'Overview': 'php/api/caches.md'
- 'Persistent Caches': 'php/api/caches_persistent-caches.md'
- 'Runtime Caches': 'php/api/caches_runtime-caches.md'
- 'Comments': 'php/api/comments.md'
- 'Cronjobs': 'php/api/cronjobs.md'
- 'Events': 'php/api/events.md'
- 'File Uploads': 'php/api/file_uploads.md'
- 'Form Builder':
- 'Overview': 'php/api/form_builder/overview.md'
- 'Structure': 'php/api/form_builder/structure.md'
- 'Fields': 'php/api/form_builder/form_fields.md'
- 'Validation and Data': 'php/api/form_builder/validation_data.md'
- 'Dependencies': 'php/api/form_builder/dependencies.md'
- 'Package Installation Plugins': 'php/api/package_installation_plugins.md'
- 'RPC API': 'php/api/rpc_api.md'
- 'User Activity Events': 'php/api/user_activity_events.md'
- 'User Activity Points': 'php/api/user_activity_points.md'
- 'User Notifications': 'php/api/user_notifications.md'
- 'RSS Feeds': 'php/api/rss_feeds.md'
- 'Sitemaps': 'php/api/sitemaps.md'
- 'Code Style': 'php/code-style.md'
- 'Apps': 'php/apps.md'
- 'GDPR': 'php/gdpr.md'
- 'Languages, Templates & CSS':
- 'Languages': 'view/languages.md'
- 'Templates': 'view/templates.md'
- 'Template Modifiers': 'view/template-modifiers.md'
- 'Template Plugins': 'view/template-plugins.md'
- 'CSS': 'view/css.md'
- 'TypeScript and JavaScript API':
- 'General Usage': 'javascript/general-usage.md'
- 'TypeScript': 'javascript/typescript.md'
- 'Components':
- 'CKEditor 5': 'javascript/components_ckeditor5.md'
- 'Confirmation': 'javascript/components_confirmation.md'
- 'Dialog': 'javascript/components_dialog.md'
- 'Google Maps': 'javascript/components_google_maps.md'
- 'Guest Token': 'javascript/components_guest_token.md'
- 'Notices': 'javascript/components_notice.md'
- 'Pagination': 'javascript/components_pagination.md'
- 'RPC API': 'javascript/components_rpc_api.md'
- 'New API':
- 'Writing a module': 'javascript/new-api_writing-a-module.md'
- 'Core Functions': 'javascript/new-api_core.md'
- 'DOM': 'javascript/new-api_dom.md'
- 'Event Handling': 'javascript/new-api_events.md'
- 'Ajax': 'javascript/new-api_ajax.md'
- 'Dialogs': 'javascript/new-api_dialogs.md'
- 'Browser and Screen Sizes': 'javascript/new-api_browser.md'
- 'User Interface': 'javascript/new-api_ui.md'
- 'Legacy API': 'javascript/legacy-api.md'
- 'Code Snippets': 'javascript/code-snippets.md'
- 'Package Components':
- 'package.xml': 'package/package-xml.md'
- 'Bootstrap Scripts': 'package/bootstrap-scripts.md'
- 'PIPs':
- 'Overview': 'package/pip.md'
- 'aclOption': 'package/pip/acl-option.md'
- 'acpMenu': 'package/pip/acp-menu.md'
- 'acpSearchProvider': 'package/pip/acp-search-provider.md'
- 'acpTemplate': 'package/pip/acp-template.md'
- 'acpTemplateDelete': 'package/pip/acp-template-delete.md'
- 'bbcode': 'package/pip/bbcode.md'
- 'box': 'package/pip/box.md'
- 'clipboardAction': 'package/pip/clipboard-action.md'
- 'coreObject': 'package/pip/core-object.md'
- 'cronjob': 'package/pip/cronjob.md'
- 'database': 'package/pip/database.md'
- 'eventListener': 'package/pip/event-listener.md'
- 'file': 'package/pip/file.md'
- 'fileDelete': 'package/pip/file-delete.md'
- 'language': 'package/pip/language.md'
- 'mediaProvider': 'package/pip/media-provider.md'
- 'menu': 'package/pip/menu.md'
- 'menuItem': 'package/pip/menu-item.md'
- 'objectType': 'package/pip/object-type.md'
- 'objectTypeDefinition': 'package/pip/object-type-definition.md'
- 'option': 'package/pip/option.md'
- 'page': 'package/pip/page.md'
- 'pip': 'package/pip/pip.md'
- 'script': 'package/pip/script.md'
- 'smiley': 'package/pip/smiley.md'
- 'sql': 'package/pip/sql.md'
- 'style': 'package/pip/style.md'
- 'template': 'package/pip/template.md'
- 'templateDelete': 'package/pip/template-delete.md'
- 'templateListener': 'package/pip/template-listener.md'
- 'userGroupOption': 'package/pip/user-group-option.md'
- 'userMenu': 'package/pip/user-menu.md'
- 'userNotificationEvent': 'package/pip/user-notification-event.md'
- 'userOption': 'package/pip/user-option.md'
- 'userProfileMenu': 'package/pip/user-profile-menu.md'
- 'ACP Menu Items': 'package/acp-menu-items.md'
- 'Database PHP API': 'package/database-php-api.md'
- 'Migration':
- 'From WoltLab Suite 6.0':
- 'PHP API': 'migration/wsc60/php.md'
- 'Templates': 'migration/wsc60/templates.md'
- 'Deprecations and Removals': 'migration/wsc60/deprecations_removals.md'
- 'From WoltLab Suite 5.5':
- 'PHP API': 'migration/wsc55/php.md'
- 'TypeScript and JavaScript': 'migration/wsc55/javascript.md'
- 'Templates': 'migration/wsc55/templates.md'
- 'Icons': 'migration/wsc55/icons.md'
- 'Dialogs': 'migration/wsc55/dialogs.md'
- 'Third Party Libraries': 'migration/wsc55/libraries.md'
- 'Deprecations and Removals': 'migration/wsc55/deprecations_removals.md'
- 'From WoltLab Suite 5.4':
- 'PHP API': 'migration/wsc54/php.md'
- 'TypeScript and JavaScript': 'migration/wsc54/javascript.md'
- 'Templates': 'migration/wsc54/templates.md'
- 'Third Party Libraries': 'migration/wsc54/libraries.md'
- 'Deprecations and Removals': 'migration/wsc54/deprecations_removals.md'
- 'From WoltLab Suite 5.3':
- 'PHP API': 'migration/wsc53/php.md'
- 'Session Handling and Authentication': 'migration/wsc53/session.md'
- 'TypeScript and JavaScript': 'migration/wsc53/javascript.md'
- 'Templates': 'migration/wsc53/templates.md'
- 'Third Party Libraries': 'migration/wsc53/libraries.md'
- 'From WoltLab Suite 5.2':
- 'PHP API': 'migration/wsc52/php.md'
- 'Templates and Languages': 'migration/wsc52/templates.md'
- 'Third Party Libraries': 'migration/wsc52/libraries.md'
- 'From WoltLab Suite 3.1':
- 'PHP API': 'migration/wsc31/php.md'
- 'From WoltLab Suite 3.0':
- 'PHP API': 'migration/wsc30/php.md'
- 'JavaScript API': 'migration/wsc30/javascript.md'
- 'Templates': 'migration/wsc30/templates.md'
- 'CSS': 'migration/wsc30/css.md'
- 'Package Components': 'migration/wsc30/package.md'
- 'From WCF 2.1':
- 'PHP API': 'migration/wcf21/php.md'
- 'Templates': 'migration/wcf21/templates.md'
- 'CSS': 'migration/wcf21/css.md'
- 'Package Components': 'migration/wcf21/package.md'
- 'Tutorials':
- 'Tutorial Series':
- 'Overview': 'tutorial/series/overview.md'
- 'Part 1': 'tutorial/series/part_1.md'
- 'Part 2': 'tutorial/series/part_2.md'
- 'Part 3': 'tutorial/series/part_3.md'
- 'Part 4': 'tutorial/series/part_4.md'
- 'Part 5': 'tutorial/series/part_5.md'
- 'Part 6': 'tutorial/series/part_6.md'
plugins:
- git-revision-date
- search
- macros:
j2_comment_start_string: '{jinja#'
j2_variable_start_string: '{jinja{'
markdown_extensions:
- toc:
permalink: '#'
toc_depth: 4
- admonition
- abbr
- pymdownx.highlight:
linenums: true
extend_pygments_lang:
- name: php
lang: php
options:
startinline: true
- pymdownx.superfences
- pymdownx.snippets:
base_path: 'snippets/'
extra_css:
- stylesheets/extra.css
extra:
version:
provider: mike
social: true