Sylius/docs
Grzegorz Sadowski 3bc21174cf
Merge branch '1.12' into 1.13
* 1.12:
  [Behat] Minor scenarios improvements
  Fixes after CR
  Test adding similar products
  Test adding new simple product
  Test adding new taxon
  [Behat] Minor scenarios improvements after code review
  [Checkout] Add scenario for preventing from a potential XSS attack
  [AddressBook] Add scenario for preventing from a potential XSS attack
  Use function from UIBundle
  Add sanitizer function to UIBundle
  Add js sanitizeInput function
  Fix product-auto-complete
  Use function from UIBundle
  Fix potential xss in admin panel
  [Maintenance] Remove unnecessary line
  [Maintenance] Update docker docs
2024-05-10 10:28:17 +02:00
..
_exts Update versions in the "Submitting a Patch" doc 2023-02-08 14:35:14 +01:00
_images Merge branch '1.11' into 1.12 2022-12-09 11:57:38 +01:00
_themes/sylius_rtd_theme [Docs] Improve visibility of Sylius Plus 2024-03-22 10:40:34 +01:00
bdd Replace http with https 2023-05-01 11:04:17 +02:00
book Merge branch '1.12' into 1.13 2024-05-10 10:28:17 +02:00
components_and_bundles Merge branch 1.12 into 1.13 2023-05-02 10:20:30 +02:00
cookbook Merge branch '1.12' into 1.13 2024-05-10 10:28:17 +02:00
customization [UPMERGE] 1.12 -> 1.13 (#15691) 2024-01-03 15:00:47 +01:00
getting-started-with-sylius Merge branch '1.12' into 1.13 2024-05-10 10:28:17 +02:00
performance Merge branch '1.10' into 1.11 2022-01-27 11:13:44 +01:00
.dockerignore [docker][docs]Create Docker Compose configuration file for documentation 2022-06-08 17:47:47 +02:00
.gitignore Update sensio.sphinx 2020-01-20 13:07:36 +01:00
build.sh [CI] Switch documentation build from Travis to GitHub Actions 2020-11-25 14:41:53 +01:00
conf.py New year 2024 2024-01-04 14:21:06 +01:00
docker-compose.yml [docs][docker]Auto build after each change 2022-08-22 18:29:52 +02:00
Dockerfile [docker][docs]Create Docker Compose configuration file for documentation 2022-06-08 17:47:47 +02:00
favicon.ico favicon 2022-05-11 19:21:42 +02:00
index.rst [Docs] Improve visibility of Sylius Plus 2024-03-22 10:40:34 +01:00
README.md Replace http with https 2023-05-01 11:04:17 +02:00
redirection_map Remove migrating to webpack page from docs 2022-09-21 12:38:19 +02:00
requirements.txt [Documentation] Add alabaster to build requirements 2024-01-11 15:38:26 +01:00

Sylius Documentation

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.

Sylius on Twitter

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

Issues

The documentation uses GitHub issues.

Build

Traditional

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.

Docker

Execute Docker Compose command and enter localhost

docker compose up -d
open localhost

Authors

See the list of our amazing contributors.