Commit | Line | Data |
---|---|---|
9a9a0f88 MS |
1 | site_name: WoltLab Suite Documentation |
2 | theme: | |
00f6a0ba MS |
3 | name: material |
4 | language: en | |
5 | custom_dir: overrides | |
6 | logo: assets/logo.png | |
7 | favicon: assets/default.favicon.ico | |
ad77cbd4 MS |
8 | palette: |
9 | primary: teal | |
c4a26d0f | 10 | font: false |
9a9a0f88 | 11 | copyright: Copyright © 2020 WoltLab GmbH |
3bf25ab6 | 12 | repo_url: https://github.com/WoltLab/docs.woltlab.com |
0de5751f | 13 | edit_uri: edit/5.4/docs/ |
9a9a0f88 MS |
14 | |
15 | nav: | |
00f6a0ba | 16 | - 'Getting Started': 'getting-started.md' |
9a9a0f88 | 17 | |
00f6a0ba MS |
18 | - 'PHP API': |
19 | - 'Pages': 'php/pages.md' | |
20 | - 'Database Objects': 'php/database-objects.md' | |
21 | - 'Database Access': 'php/database-access.md' | |
22 | - 'Exceptions': 'php/exceptions.md' | |
23 | - 'API': | |
24 | - 'Caches': 'php/api/caches.md' | |
25 | - 'Comments': 'php/api/comments.md' | |
26 | - 'Cronjobs': 'php/api/cronjobs.md' | |
27 | - 'Events': 'php/api/events.md' | |
35de1852 MS |
28 | - 'Form Builder': |
29 | - 'Overview': 'php/api/form_builder/overview.md' | |
30 | - 'Structure': 'php/api/form_builder/structure.md' | |
31 | - 'Fields': 'php/api/form_builder/form_fields.md' | |
32 | - 'Validation and Data': 'php/api/form_builder/validation_data.md' | |
33 | - 'Dependencies': 'php/api/form_builder/dependencies.md' | |
00f6a0ba MS |
34 | - 'Package Installation Plugins': 'php/api/package_installation_plugins.md' |
35 | - 'User Activity Points': 'php/api/user_activity_points.md' | |
36 | - 'User Notifications': 'php/api/user_notifications.md' | |
37 | - 'Sitemaps': 'php/api/sitemaps.md' | |
38 | - 'Code Style': 'php/code-style.md' | |
39 | - 'Apps': 'php/apps.md' | |
40 | - 'GDPR': 'php/gdpr.md' | |
9a9a0f88 | 41 | |
00f6a0ba MS |
42 | - 'Languages, Templates & CSS': |
43 | - 'Languages': 'view/languages.md' | |
44 | - 'Templates': 'view/templates.md' | |
45 | - 'CSS': 'view/css.md' | |
9a9a0f88 | 46 | |
efadd81d | 47 | - 'TypeScript and JavaScript API': |
00f6a0ba | 48 | - 'General Usage': 'javascript/general-usage.md' |
efadd81d | 49 | - 'TypeScript': 'javascript/typescript.md' |
00f6a0ba MS |
50 | - 'New API': |
51 | - 'Writing a module': 'javascript/new-api_writing-a-module.md' | |
52 | - 'Data Structures': 'javascript/new-api_data-structures.md' | |
53 | - 'Core Functions': 'javascript/new-api_core.md' | |
54 | - 'DOM': 'javascript/new-api_dom.md' | |
55 | - 'Event Handling': 'javascript/new-api_events.md' | |
56 | - 'Ajax': 'javascript/new-api_ajax.md' | |
57 | - 'Dialogs': 'javascript/new-api_dialogs.md' | |
58 | - 'Browser and Screen Sizes': 'javascript/new-api_browser.md' | |
59 | - 'User Interface': 'javascript/new-api_ui.md' | |
60 | - 'Legacy API': 'javascript/legacy-api.md' | |
61 | - 'Helper Functions': 'javascript/helper-functions.md' | |
62 | - 'Code Snippets': 'javascript/code-snippets.md' | |
9a9a0f88 | 63 | |
00f6a0ba MS |
64 | - 'Package Components': |
65 | - 'package.xml': 'package/package-xml.md' | |
0066874e MS |
66 | - 'PIPs': |
67 | - 'Overview': 'package/pip.md' | |
68 | - 'aclOption': 'package/pip/acl-option.md' | |
69 | - 'acpMenu': 'package/pip/acp-menu.md' | |
70 | - 'acpSearchProvider': 'package/pip/acp-search-provider.md' | |
71 | - 'acpTemplate': 'package/pip/acp-template.md' | |
72 | - 'bbcode': 'package/pip/bbcode.md' | |
73 | - 'box': 'package/pip/box.md' | |
74 | - 'clipboardAction': 'package/pip/clipboard-action.md' | |
75 | - 'coreObject': 'package/pip/core-object.md' | |
76 | - 'cronjob': 'package/pip/cronjob.md' | |
77 | - 'eventListener': 'package/pip/event-listener.md' | |
78 | - 'file': 'package/pip/file.md' | |
79 | - 'language': 'package/pip/language.md' | |
80 | - 'mediaProvider': 'package/pip/media-provider.md' | |
81 | - 'menu': 'package/pip/menu.md' | |
82 | - 'menuItem': 'package/pip/menu-item.md' | |
83 | - 'objectType': 'package/pip/object-type.md' | |
84 | - 'objectTypeDefinition': 'package/pip/object-type-definition.md' | |
85 | - 'option': 'package/pip/option.md' | |
86 | - 'page': 'package/pip/page.md' | |
87 | - 'pip': 'package/pip/pip.md' | |
88 | - 'script': 'package/pip/script.md' | |
89 | - 'smiley': 'package/pip/smiley.md' | |
90 | - 'sql': 'package/pip/sql.md' | |
91 | - 'style': 'package/pip/style.md' | |
92 | - 'template': 'package/pip/template.md' | |
93 | - 'templateListener': 'package/pip/template-listener.md' | |
94 | - 'userGroupOption': 'package/pip/user-group-option.md' | |
95 | - 'userMenu': 'package/pip/user-menu.md' | |
96 | - 'userNotificationEvent': 'package/pip/user-notification-event.md' | |
97 | - 'userOption': 'package/pip/user-option.md' | |
98 | - 'userProfileMenu': 'package/pip/user-profile-menu.md' | |
99 | - 'Database PHP API': 'package/database-php-api.md' | |
9a9a0f88 | 100 | |
00f6a0ba MS |
101 | - 'Migration': |
102 | - 'Migrating from WSC 5.3': | |
103 | - 'PHP API': 'migration/wsc53/php.md' | |
104 | - 'Session Handling and Authentication': 'migration/wsc53/session.md' | |
efadd81d | 105 | - 'TypeScript and JavaScript': 'migration/wsc53/javascript.md' |
00f6a0ba MS |
106 | - 'Templates': 'migration/wsc53/templates.md' |
107 | - 'Third Party Libraries': 'migration/wsc53/libraries.md' | |
108 | - 'Migrating from WSC 5.2': | |
109 | - 'PHP API': 'migration/wsc52/php.md' | |
110 | - 'Templates and Languages': 'migration/wsc52/templates.md' | |
111 | - 'Third Party Libraries': 'migration/wsc52/libraries.md' | |
112 | - 'Migrating from WSC 3.1': | |
113 | - 'PHP API': 'migration/wsc31/php.md' | |
114 | - 'Migrating from WSC 3.0': | |
115 | - 'PHP API': 'migration/wsc30/php.md' | |
116 | - 'JavaScript API': 'migration/wsc30/javascript.md' | |
117 | - 'Templates': 'migration/wsc30/templates.md' | |
118 | - 'CSS': 'migration/wsc30/css.md' | |
119 | - 'Package Components': 'migration/wsc30/package.md' | |
120 | - 'Migrating from WCF 2.1': | |
121 | - 'PHP API': 'migration/wcf21/php.md' | |
122 | - 'Templates': 'migration/wcf21/templates.md' | |
123 | - 'CSS': 'migration/wcf21/css.md' | |
124 | - 'Package Components': 'migration/wcf21/package.md' | |
9a9a0f88 | 125 | |
00f6a0ba | 126 | - 'Tutorials': |
7e276cf9 MS |
127 | - 'Tutorial Series': |
128 | - 'Overview': 'tutorial/series/overview.md' | |
129 | - 'Part 1': 'tutorial/series/part_1.md' | |
130 | - 'Part 2': 'tutorial/series/part_2.md' | |
131 | - 'Part 3': 'tutorial/series/part_3.md' | |
9a9a0f88 | 132 | |
2063d788 TD |
133 | plugins: |
134 | - git-revision-date | |
33caa8ae | 135 | - search |
2063d788 | 136 | |
9a9a0f88 | 137 | markdown_extensions: |
00f6a0ba MS |
138 | - toc: |
139 | permalink: "#" | |
140 | toc_depth: 4 | |
141 | - admonition | |
142 | - abbr | |
143 | - pymdownx.highlight: | |
144 | extend_pygments_lang: | |
145 | - name: php | |
146 | lang: php | |
147 | options: | |
148 | startinline: true | |
149 | - pymdownx.superfences | |
150 | - pymdownx.snippets: | |
151 | base_path: "snippets/" | |
9a9a0f88 MS |
152 | |
153 | extra_css: | |
00f6a0ba | 154 | - stylesheets/extra.css |
1a4ec0eb TD |
155 | |
156 | extra: | |
157 | version: | |
158 | provider: mike |