This documentation assumes you have a working knowledge of the Symfony Framework. If you’re not familiar with Symfony, please start with reading the Quick Tour from the Symfony documentation.
The Book, Customization Guide, REST API Reference, Cookbook, Contribution Guide and Behat Guide are chapters describing the usage of the whole Sylius platform, on the examples for Sylius-Standard distribution.
For tips on using only some bundles of Sylius head to Bundles and Components docs.
Getting Started with Sylius¶
The essential guide for the Sylius newcomers that want to know it’s most important features, quickly see the power of customization and run their first Sylius shop within a few hours.
The Developer’s guide to leveraging the flexibility of Sylius. Here you will find all the concepts used in the Sylius platform. The Book helps to understand how Sylius works.
The Customization Guide¶
The Customization Guide is helpful while wanting to adapt Sylius to your personal business needs.
- Customizing Models
- Customizing Forms
- Customizing Repositories
- Customizing Factories
- Customizing Controllers
- Customizing Validation
- Customizing Menus
- Customizing Templates
- Customizing Translations
- Customizing Flashes
- Customizing State Machines
- Customizing Grids
- Customizing Fixtures
- Customizing Fixture Suites
- Tips & Tricks
The Theming Guide is useful when trying do develop custom layout for Sylius shops.
Plugin Development Guide¶
If you’re wondering how to share awesome features you have/want to have for Sylius with the Open Source community, here you will find a comprehensive guide to plugins development from the idea to sharing the plugin with the world. Remember that you can use all the customization techniques in Plugins.
The Sylius API¶
In the Sylius API chapter you’ll understand both the new Sylius API and the old Admin API.
The BDD Guide¶
In the BDD Guide you will learn how to write clean and reusable features, contexts and pages using Behat.
The Contribution Guide¶
The Contribution Guide to Sylius.
Components & Bundles¶
Documentation of all Sylius components and bundles useful when using them standalone.