This directory contains documentation for Sylius - Open Source eCommerce platform on top of Symfony, available on docs.sylius.com.

It is hosted by the great readthedocs.org.

If you want to keep up with all the updates, follow the official Sylius account on twitter.

The documentation uses GitHub issues.

To test the documentation before a commit:

• Install pip, Python package manager

• Download the documentation requirements:

  pip install -r requirements.txt

  This makes sure that the version of Sphinx you'll get is >=1.4.2!

• Install Sphinx

  pip install Sphinx

• In the docs directory run sphinx-build -b html . build and view the generated HTML files in the build directory.

Execute Docker Compose command and enter localhost

docker compose up -d
open localhost

See the list of our amazing contributors.