Sylius Docs Plugin

Features

• Render Markdown-based documentation directly inside the Sylius Admin panel
• Easily add editable .md files inside the /documentation directory
• Secure access: only admins can view the docs

Installation

1. Run:

   composer require 3brs/sylius-documentation-plugin

2. Register the bundle in your config/bundles.php:

   ThreeBRS\SyliusDocumentationPlugin\ThreeBRSSyliusDocumentationPlugin::class => ['all' => true],

3. Import the plugin's routing files in config/routes.yaml:

   threebrs_sylius_documentation:
       resource: "@ThreeBRSSyliusDocumentationPlugin/config/routes.yaml"
       prefix: '%sylius_admin.path_name%'

4. Import the plugin's config file in config/packages/_sylius.yaml:

   imports:
       # ...
       - { resource: "@ThreeBRSSyliusDocumentationPlugin/config/config.yaml" }

5. (Optional) Redefine the path to your documentation directory in config/bundles/threebrs_sylius_documentation.yaml:

   threebrs_sylius_documentation:
       docs_path: '%kernel.cache_dir%/our/custom/docs_dir'

Usage

• Add a documentation/index.md file in the root of your Sylius project (necessary; acts as your table of contents).

• Add your file URLs to documentation/index.md like so:

  # 🧭 Table of Contents
  
  Welcome to the internal documentation.
  
  - [Getting Started](getting-started.md)
  
  - [Product Import](product-import.md)
  
  - [Shipping Setup](shipping-setup.md)

• Access your documentation using the Documentation link in the admin panel sidebar.

• You will see the documentation/index.md you created as a table of contents for your files.

• Missing files will show Not Found with the name of the file not found.

Requirements

Package	Version
PHP	^8.3
Sylius	^2.1

For Sylius 2.0 support, use version 2.x of this plugin.

Development

Usage

• Develop plugin logic inside /src
• See Makefile for useful dev tools

Testing

After making changes, make sure tests and checks pass:

make ci

License

This library is under the MIT license.

Credits

Developed by 3BRS