forked from aimeos/aimeos-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
396 lines (392 loc) · 17.7 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
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
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
site_dir: docs/2021.x
site_url: https://aimeos.org/docs/2021.x/
site_name: Aimeos documentation
repo_url: https://github.com/aimeos/aimeos-docs
edit_uri: blob/master/src/
markdown_extensions:
- toc:
baselevel: 2
permalink: '#'
- def_list
- admonition
- pymdownx.tabbed
- pymdownx.highlight:
extend_pygments_lang:
- name: php
lang: php
options:
startinline: true
- pymdownx.superfences
plugins:
- algolia
docs_dir: src
theme:
name: material
custom_dir: theme
favicon: assets/favicon.svg
logo: https://aimeos.org/fileadmin/logos/logo-aimeos-blue.svgz
font:
text: Noto Sans
extra_css:
- assets/aimeos.css?v4
extra_javascript:
- assets/aimeos.js?v4
- /docs/versions.js?v4
extra:
disqus: aimeos
social:
- icon: fontawesome/brands/github
link: https://github.com/aimeos
title: Github
- icon: fontawesome/brands/facebook
link: https://facebook.com/Aimeos
title: Facebook
- icon: fontawesome/brands/twitter
link: https://twitter.com/aimeos
title: Twitter
- icon: fontawesome/brands/youtube
link: https://youtube.com/c/aimeos
title: Youtube
analytics:
url: https://aimeos.org/stats
siteid: 1
nav:
- Laravel:
- Getting started: laravel/index.md
- Setup: laravel/setup.md
- Customize: laravel/customize.md
- Extend: laravel/extend.md
- Optimize: laravel/optimize.md
- Create themes: laravel/themes.md
- Symfony:
- Getting started: symfony/index.md
- Setup: symfony/setup.md
- Customize: symfony/customize.md
- Extend: symfony/extend.md
- Optimize: symfony/optimize.md
- TYPO3:
- Getting started: typo3/index.md
- Setup: typo3/setup.md
- Customize: typo3/customize.md
- Extend: typo3/extend.md
- Optimize: typo3/optimize.md
- FAQ: typo3/faq.md
- User manual:
- Getting started: manual/index.md
- Filtering lists: manual/filtering-lists.md
- Working with sites: manual/working-with-sites.md
- Currencies/languages: manual/locales.md
- Products:
- Available products: manual/products.md
- Product details: manual/product-details.md
- Categories:
- Manage categories: manual/categories.md
- Category details: manual/category-details.md
- Pricing rules:
- Available rules: manual/rules.md
- Rule details: manual/rule-details.md
- Built-in extensions: manual/rule-decorators.md
- Vouchers/Coupons:
- Available coupon: manual/coupons.md
- Coupon details: manual/coupon-details.md
- Built-in extensions: manual/coupon-decorators.md
- Payment/Delivery:
- Available services: manual/services.md
- Service details: manual/service-details.md
- Built-in extensions: manual/service-decorators.md
- Orders: manual/orders.md
- Subscriptions: manual/subscriptions.md
- Basket plugins:
- Available plugins: manual/plugins.md
- Plugins details: manual/plugin-details.md
- Development:
- Getting started: developer/index.md
- Architecture: developer/architecture.md
- Create extensions: developer/extensions.md
- Add translations: developer/translations.md
- Git workflow: developer/git.md
- Phing build system: developer/phing.md
- Frontend:
- HTML:
- Theme basics: frontend/html/theme-basics.md
- Adapt themes: frontend/html/adapt-themes.md
- Create new themes: frontend/html/create-themes.md
- Overwrite templates: frontend/html/overwrite-templates.md
- Implement components: frontend/html/implement-components.md
- Extend components: frontend/html/extend-components.md
- Create subparts: frontend/html/create-subparts.md
- Account components: frontend/html/account-components.md
- Basket components: frontend/html/basket-components.md
- Catalog components: frontend/html/catalog-components.md
- Checkout components: frontend/html/checkout-components.md
- E-Mail components: frontend/html/email-components.md
- Locale components: frontend/html/locale-components.md
- Adapt price format: frontend/html/adapt-price-format.md
- Parameter names: frontend/html/parameter-names.md
- JSON API:
- Getting started: frontend/jsonapi/index.md
- Search basics: frontend/jsonapi/basics.md
- Catalog handling: frontend/jsonapi/catalog.md
- Basket management: frontend/jsonapi/baskets.md
- Basket products: frontend/jsonapi/basket-products.md
- Basket addresses: frontend/jsonapi/basket-addresses.md
- Basket services: frontend/jsonapi/basket-services.md
- Basket coupons: frontend/jsonapi/basket-coupons.md
- Order management: frontend/jsonapi/orders.md
- Customer handling: frontend/jsonapi/customer.md
- Customer addresses: frontend/jsonapi/customer-addresses.md
- Customer properties: frontend/jsonapi/customer-properties.md
- Customer relations: frontend/jsonapi/customer-relations.md
- Customer reviews: frontend/jsonapi/customer-reviews.md
- Get reviews: frontend/jsonapi/reviews.md
- Admin:
- JQAdm backend:
- Overwrite templates: admin/jqadm/overwrite-templates.md
- Implement panels: admin/jqadm/implement-panels.md
- Panel templates: admin/jqadm/panel-templates.md
- Create subparts: admin/jqadm/create-subparts.md
- Extend panels: admin/jqadm/extend-panels.md
- Customize: admin/jqadm/customize.md
- JsonAdm API:
- Overview: admin/jsonadm/index.md
- Retrieve metadata: admin/jsonadm/metadata.md
- Search and filter: admin/jsonadm/search-filter.md
- Manage resources: admin/jsonadm/manage-resources.md
- Manage trees: admin/jsonadm/manage-trees.md
- Manage index: admin/jsonadm/manage-index.md
- Error handling: admin/jsonadm/error-handling.md
- Cronjobs:
- Available cronjobs: cronjobs/index.md
- Create job controller: cronjobs/create-job-controller.md
- Product CSV import: cronjobs/product-csv-import.md
- Category CSV import: cronjobs/catalog-csv-import.md
- Subscription processors: cronjobs/subscription-processors.md
- Models:
- Managing items: models/managing-items.md
- Filtering items: models/search-filter.md
- Extend managers: models/extend-managers.md
- Providers:
- Service provider:
- Basics: providers/service/index.md
- Payment provider: providers/service/payment.md
- Delivery provider: providers/service/delivery.md
- Create decorators: providers/service/decorators.md
- Write unit tests: providers/service/unittests.md
- Basket plugins: providers/basket-plugins.md
- Coupon provider: providers/coupon.md
- Pricing rules: providers/rules.md
- Infrastructure:
- Database: infrastructure/databases.md
- Migrations: infrastructure/schema-migrations.md
- DI container: infrastructure/context.md
- Read/write files: infrastructure/read-write-files.md
- View and helpers: infrastructure/view-helpers.md
- Configuration:
- HTML clients:
- Account download: config/client-html/account-download.md
- Account favorite: config/client-html/account-favorite.md
- Account history: config/client-html/account-history.md
- Account index: config/client-html/account-index.md
- Account profile: config/client-html/account-profile.md
- Account review: config/client-html/account-review.md
- Account subscription: config/client-html/account-subscription.md
- Account watch: config/client-html/account-watch.md
- Basket bulk: config/client-html/basket-bulk.md
- Basket cache: config/client-html/basket-cache.md
- Basket mini: config/client-html/basket-mini.md
- Basket related: config/client-html/basket-related.md
- Basket standard: config/client-html/basket-standard.md
- Catalog actions: config/client-html/catalog-actions.md
- Catalog attribute: config/client-html/catalog-attribute.md
- Catalog count: config/client-html/catalog-count.md
- Catalog detail: config/client-html/catalog-detail.md
- Catalog filter: config/client-html/catalog-filter.md
- Catalog home: config/client-html/catalog-home.md
- Catalog lists: config/client-html/catalog-lists.md
- Catalog partials: config/client-html/catalog-partials.md
- Catalog price: config/client-html/catalog-price.md
- Catalog product: config/client-html/catalog-product.md
- Catalog search: config/client-html/catalog-search.md
- Catalog selection: config/client-html/catalog-selection.md
- Catalog session: config/client-html/catalog-session.md
- Catalog social: config/client-html/catalog-social.md
- Catalog stage: config/client-html/catalog-stage.md
- Catalog stock: config/client-html/catalog-stock.md
- Catalog suggest: config/client-html/catalog-suggest.md
- Catalog supplier: config/client-html/catalog-supplier.md
- Catalog tree: config/client-html/catalog-tree.md
- Checkout address: config/client-html/checkout-address.md
- Checkout confirm: config/client-html/checkout-confirm.md
- Checkout standard: config/client-html/checkout-standard.md
- Checkout update: config/client-html/checkout-update.md
- Common address: config/client-html/common-address.md
- Common cache: config/client-html/common-cache.md
- Common decorators: config/client-html/common-decorators.md
- Common partials: config/client-html/common-partials.md
- Common summary: config/client-html/common-summary.md
- Common template: config/client-html/common-template.md
- E-mail account: config/client-html/email-account.md
- E-mail common: config/client-html/email-common.md
- E-mail delivery: config/client-html/email-delivery.md
- E-mail payment: config/client-html/email-payment.md
- E-mail subscription: config/client-html/email-subscription.md
- E-mail voucher: config/client-html/email-voucher.md
- E-mail watch: config/client-html/email-watch.md
- Locale select: config/client-html/locale-select.md
- Supplier detail: config/client-html/supplier-detail.md
- JSON REST API:
- Common: config/client-jsonapi/common.md
- Decorators: config/client-jsonapi/decorators.md
- Standard: config/client-jsonapi/standard.md
- URL: config/client-jsonapi/url.md
- Attribute: config/client-jsonapi/attribute.md
- Basket: config/client-jsonapi/basket.md
- Catalog: config/client-jsonapi/catalog.md
- Customer: config/client-jsonapi/customer.md
- Locale: config/client-jsonapi/locale.md
- Order: config/client-jsonapi/order.md
- Product: config/client-jsonapi/product.md
- Review: config/client-jsonapi/review.md
- Service: config/client-jsonapi/service.md
- Site: config/client-jsonapi/site.md
- Stock: config/client-jsonapi/stock.md
- Subscription: config/client-jsonapi/subscription.md
- Supplier: config/client-jsonapi/supplier.md
- Frontend controller:
- Attribute: config/controller-frontend/attribute.md
- Basket: config/controller-frontend/basket.md
- Catalog: config/controller-frontend/catalog.md
- Common: config/controller-frontend/common.md
- Customer: config/controller-frontend/customer.md
- Locale: config/controller-frontend/locale.md
- Order: config/controller-frontend/order.md
- Product: config/controller-frontend/product.md
- Review: config/controller-frontend/review.md
- Service: config/controller-frontend/service.md
- Site: config/controller-frontend/site.md
- Stock: config/controller-frontend/stock.md
- Subscription: config/controller-frontend/subscription.md
- Supplier: config/controller-frontend/supplier.md
- JQAdm backend:
- Api: config/admin-jqadm/api.md
- Dataset: config/admin-jqadm/dataset.md
- Common: config/admin-jqadm/common.md
- Partial: config/admin-jqadm/partial.md
- Permissions: config/admin-jqadm/resource.md
- Template: config/admin-jqadm/template.md
- URL: config/admin-jqadm/url.md
- Attribute: config/admin-jqadm/attribute.md
- Catalog: config/admin-jqadm/catalog.md
- Coupon: config/admin-jqadm/coupon.md
- Customer: config/admin-jqadm/customer.md
- Dashboard: config/admin-jqadm/dashboard.md
- Group: config/admin-jqadm/group.md
- Locale: config/admin-jqadm/locale.md
- Log: config/admin-jqadm/log.md
- Order: config/admin-jqadm/order.md
- Plugin: config/admin-jqadm/plugin.md
- Product: config/admin-jqadm/product.md
- Review: config/admin-jqadm/review.md
- Rule: config/admin-jqadm/rule.md
- Service: config/admin-jqadm/service.md
- Settings: config/admin-jqadm/settings.md
- Subscription: config/admin-jqadm/subscription.md
- Supplier: config/admin-jqadm/supplier.md
- Type: config/admin-jqadm/type.md
- JsonAdm API:
- Base: config/admin-jsonadm/index.md
- Common: config/admin-jsonadm/common.md
- Standard: config/admin-jsonadm/standard.md
- Decorators: config/admin-jsonadm/decorators.md
- Permissions: config/admin-jsonadm/resource.md
- URL: config/admin-jsonadm/url.md
- Attribute: config/admin-jsonadm/attribute.md
- Catalog: config/admin-jsonadm/catalog.md
- Coupon: config/admin-jsonadm/coupon.md
- Customer: config/admin-jsonadm/customer.md
- Locale: config/admin-jsonadm/locale.md
- Media: config/admin-jsonadm/media.md
- Order: config/admin-jsonadm/order.md
- Partials: config/admin-jsonadm/partials.md
- Plugin: config/admin-jsonadm/plugin.md
- Price: config/admin-jsonadm/price.md
- Product: config/admin-jsonadm/product.md
- Rule: config/admin-jsonadm/rule.md
- Service: config/admin-jsonadm/service.md
- Stock: config/admin-jsonadm/stock.md
- Supplier: config/admin-jsonadm/supplier.md
- Text: config/admin-jsonadm/text.md
- Job controller:
- Admin cache: config/controller-jobs/admin-cache.md
- Admin log: config/controller-jobs/admin-log.md
- Attribute import: config/controller-jobs/attribute-import.md
- Catalog export: config/controller-jobs/catalog-export.md
- Catalog import: config/controller-jobs/catalog-import.md
- Common: config/controller-jobs/common.md
- Coupon import: config/controller-jobs/coupon-import.md
- Customer email: config/controller-jobs/customer-email.md
- Customer group: config/controller-jobs/customer-group.md
- Customer import: config/controller-jobs/customer-import.md
- Index optimize: config/controller-jobs/index-optimize.md
- Index rebuild: config/controller-jobs/index-rebuild.md
- Media scale: config/controller-jobs/media-scale.md
- Order cleanup: config/controller-jobs/order-cleanup.md
- Order email: config/controller-jobs/order-email.md
- Order export: config/controller-jobs/order-export.md
- Order service: config/controller-jobs/order-service.md
- product bought: config/controller-jobs/product-bought.md
- product export: config/controller-jobs/product-export.md
- Product import: config/controller-jobs/product-import.md
- Stock import: config/controller-jobs/stock-import.md
- Subscription process: config/controller-jobs/subscription-process.md
- Subscription export: config/controller-jobs/subscription-export.md
- Supplier import: config/controller-jobs/supplier-import.md
- XML import: config/controller-jobs/xml-import.md
- Common controller:
- Decorators: config/controller-jobs/common.md
- Media: config/controller-common/media.md
- Order: config/controller-common/order.md
- Catalog import: config/controller-common/catalog-import.md
- Common import: config/controller-common/common-import.md
- Coupon import: config/controller-common/coupon-import.md
- Customer import: config/controller-common/customer-import.md
- Order export: config/controller-common/order-export.md
- Product import: config/controller-common/product-import.md
- Stock import: config/controller-common/stock-import.md
- Subscription export: config/controller-common/subscription-export.md
- Subscription process: config/controller-common/subscription-process.md
- Supplier import: config/controller-common/supplier-import.md
- MShop:
- Attribute: config/mshop/attribute-manager.md
- Catalog: config/mshop/catalog-manager.md
- Common: config/mshop/common-manager.md
- Coupon: config/mshop/coupon-manager.md
- Customer: config/mshop/customer-manager.md
- Index: config/mshop/index-manager.md
- Locale: config/mshop/locale-manager.md
- Media: config/mshop/media-manager.md
- Order: config/mshop/order-manager.md
- Plugin: config/mshop/plugin-manager.md
- Price: config/mshop/price-manager.md
- Product: config/mshop/product-manager.md
- Review: config/mshop/review-manager.md
- Rule: config/mshop/rule-manager.md
- Service: config/mshop/service-manager.md
- Stock: config/mshop/stock-manager.md
- Subscription: config/mshop/subscription-manager.md
- Supplier: config/mshop/supplier-manager.md
- Tag: config/mshop/tag-manager.md
- Text: config/mshop/text-manager.md
- Coupon provider: config/mshop/coupon-provider.md
- Plugin provider: config/mshop/plugin-provider.md
- Service provider: config/mshop/service-provider.md
- MAdmin:
- Cache: config/madmin/cache-manager.md
- Common: config/madmin/common-manager.md
- Job: config/madmin/job-manager.md
- Log: config/madmin/log-manager.md
- Changelog:
- 2020.x -> 2021.x : changelog/2021.x.md
- 2019.x -> 2020.x : changelog/2020.x.md
- 2018.x -> 2019.x : changelog/2019.x.md
- 2017.x -> 2018.x : changelog/2018.x.md