mkdocs.yml

site_dir: docs/master
site_url: https://aimeos.org/docs/master/


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:
      alternate_style: true
  - 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.svg
  font: false
extra_css:
  - assets/aimeos.css?v6
extra_javascript:
  - assets/aimeos.js?v6
  - /docs/versions.js?v6
extra:
  disqus: aimeos
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/aimeos
      title: Github
    - icon: fontawesome/brands/mastodon
      link: https://mastodon.social/@aimeos
      title: Mastodon
    - icon: fontawesome/brands/facebook
      link: https://facebook.com/Aimeos
      title: Facebook
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/aimeos
      title: X
    - 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
  - 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
      - 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 subscriptions: frontend/jsonapi/subscriptions.md
      - Customer reviews: frontend/jsonapi/customer-reviews.md
      - Reviews: frontend/jsonapi/reviews.md
      - Services: frontend/jsonapi/services.md
      - Stocks: frontend/jsonapi/stocks.md
      - Suppliers: frontend/jsonapi/suppliers.md
      - Site data: frontend/jsonapi/sites.md
      - Locales: frontend/jsonapi/locales.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
    - GraphQL API:
      - Overview: admin/graphql/index.md
      - Basics: admin/graphql/basics.md
      - Attributes: admin/graphql/attribute.md
      - Categories: admin/graphql/catalog.md
      - Coupons: admin/graphql/coupon.md
      - Coupon codes: admin/graphql/coupon-code.md
      - Currencies: admin/graphql/locale-currency.md
      - Customers: admin/graphql/customer.md
      - Languages: admin/graphql/locale-language.md
      - Locales: admin/graphql/locale.md
      - Media: admin/graphql/media.md
      - Orders: admin/graphql/order.md
      - Plugins: admin/graphql/plugin.md
      - Prices: admin/graphql/price.md
      - Products: admin/graphql/product.md
      - Reviews: admin/graphql/review.md
      - Rules: admin/graphql/rule.md
      - Services: admin/graphql/service.md
      - Sites: admin/graphql/locale-site.md
      - Stocks: admin/graphql/stock.md
      - Subscriptions: admin/graphql/subscription.md
      - Suppliers: admin/graphql/supplier.md
      - Texts: admin/graphql/text.md
      - Types: admin/graphql/type.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
    - Product CSV import: cronjobs/product-csv-import.md
    - Category CSV import: cronjobs/catalog-csv-import.md
    - Supplier CSV import: cronjobs/supplier-csv-import.md
    - Stock CSV import: cronjobs/stock-csv-import.md
    - Attribute XML import: cronjobs/attribute-xml-import.md
    - Category XML import: cronjobs/catalog-xml-import.md
    - Customer XML import: cronjobs/customer-xml-import.md
    - Group XML import: cronjobs/group-xml-import.md
    - Product XML import: cronjobs/product-xml-import.md
    - Supplier XML import: cronjobs/supplier-xml-import.md
    - Create job controller: cronjobs/create-job-controller.md
    - Subscription processors: cronjobs/subscription-processors.md
  - Models:
    - Managing items: models/managing-items.md
    - Filtering items: models/search-filter.md
    - Create managers: models/create-managers.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:
    - DI container: infrastructure/context.md
    - Cache: infrastructure/cache.md
    - Database: infrastructure/database.md
    - Filesystems: infrastructure/filesystem.md
    - Mails: infrastructure/mail.md
    - Migrations: infrastructure/schema-migrations.md
    - View and helpers: infrastructure/view.md
  - Configuration:
    - HTML clients:
      - Account basket: config/client-html/account-basket.md
      - 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 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 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
      - 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
      - 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
      - Basket: config/admin-jqadm/basket.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
      - 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
      - Basket cleanup: config/controller-jobs/basket-cleanup.md
      - Catalog export: config/controller-jobs/catalog-export.md
      - Catalog import: config/controller-jobs/catalog-import.md
      - Common import: config/controller-jobs/common-import.md
      - Coupon import: config/controller-jobs/coupon-import.md
      - Customer email: config/controller-jobs/customer-email.md
      - Customer import: config/controller-jobs/customer-import.md
      - Decorators: config/controller-jobs/common-decorators.md
      - Group import: config/controller-jobs/group-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
      - Order status: config/controller-jobs/order-status.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
    - MShop:
      - Attribute: config/mshop/attribute-manager.md
      - Catalog: config/mshop/catalog-manager.md
      - CMS: config/mshop/cms-manager.md
      - Common: config/mshop/common-manager.md
      - Coupon: config/mshop/coupon-manager.md
      - Customer: config/mshop/customer-manager.md
      - Group: config/mshop/group-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
      - TYPO3: config/mshop/manager-typo3.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:
    - 2023.x -> 2024.x : changelog/2024.x.md
    - 2022.x -> 2023.x : changelog/2023.x.md
    - 2021.x -> 2022.x : changelog/2022.x.md
    - 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