3brs/sylius-docs-plugin

Docs plugin for Sylius Admin Panel.

dev-main 2025-07-15 05:50 UTC

Requires

• php: ^8.2
• ext-fileinfo: *
• league/commonmark: ^2.7
• sylius/sylius: 2.0.*

Requires (Dev)

• behat/behat: ^v3.19.0
• dmore/behat-chrome-extension: ^1.4.0
• dmore/chrome-mink-driver: ^2.9.3
• doctrine/annotations: ^2.0.2
• friends-of-behat/mink: ^v1.11.0
• friends-of-behat/mink-browserkit-driver: ^v1.6.2
• friends-of-behat/mink-debug-extension: ^v2.1.0
• friends-of-behat/mink-extension: ^v2.7.5
• friends-of-behat/page-object-extension: ^v0.3.2
• friends-of-behat/suite-settings-extension: ^v1.1.0
• friends-of-behat/symfony-extension: v2.6.0
• friends-of-behat/variadic-extension: ^v1.6.0
• php-http/message-factory: ^1.1.0
• phpstan/phpstan: ^2.1.10
• phpstan/phpstan-doctrine: ^2.0.2
• phpstan/phpstan-strict-rules: ^2.0.4
• phpstan/phpstan-symfony: ^2.0.3
• phpstan/phpstan-webmozart-assert: ^2.0.0
• phpunit/phpunit: ^11.1 || ^12.0.10
• polishsymfonycommunity/symfony-mocker-container: ^v1.0.8
• rector/rector: ^2.0.10
• sylius-labs/coding-standard: ^v4.4.0
• sylius/sylius-rector: ^v3.0.0
• symfony/browser-kit: ^6.4|^7.1
• symfony/css-selector: ^6.4|^7.1
• symfony/debug-bundle: ^6.4|^7.1
• symfony/doctrine-bridge: ^6.4|^7.1
• symfony/dotenv: ^6.4|^7.1
• symfony/framework-bundle: ^6.4|^7.1
• symfony/http-foundation: ^6.4|^7.1
• symfony/http-kernel: ^6.4|^7.1
• symfony/intl: ^6.4|^7.1
• symfony/mime: ^6.4|^7.1
• symfony/web-link: ^6.4|^7.1
• symfony/web-profiler-bundle: ^6.4|^7.1
• symplify/easy-coding-standard: ^12.0

Conflicts

• api-platform/core: <2.7.13
• api-platform/symfony: <v4.1.0
• babdev/pagerfanta-bundle: <3.6.1
• doctrine/collections: <1.7.0
• doctrine/data-fixtures: <1.5.1
• doctrine/dbal: <2.13.3
• doctrine/doctrine-bundle: <2.8.0
• friendsofsymfony/rest-bundle: <3.1.0
• jms/serializer-bundle: <4.2.0
• knplabs/knp-menu: <3.3.0
• lexik/jwt-authentication-bundle: <2.12
• masterminds/html5: <2.7.5
• payum/core: <1.7.3
• polishsymfonycommunity/symfony-mocker-container: <1.0.6
• sylius/resource-bundle: <1.10.0
• sylius/sylius: <2.0.6
• symfony/css-selector: <4.4.24
• symfony/framework-bundle: >=5.4.0 <=5.4.20|>=6.0.0 <=6.0.16|>=6.1.0 <=6.1.8|>=6.2.0 <=6.2.2|6.2.8
• symfony/mime: <5.4.0
• symfony/web-link: <5.3.0
• symplify/easy-coding-standard: <10.2.0|12.5.10
• twig/twig: <2.14.7
• webmozart/assert: <1.11.0
• willdurand/negotiation: <3.0

MIT

• documentation
• sylius
• sylius-plugin

README

Sylius Docs Plugin

Features

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

Installation

1. Run:

   composer require 3brs/sylius-docs-plugin

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

   ThreeBRS\SyliusDocsPlugin\ThreeBRSSyliusDocsPlugin::class => ['all' => true],

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

   threebrs_docs_plugin_routing_file:
       resource: "@ThreeBRSSyliusDocsPlugin/config/routes.yaml"
       prefix: '%sylius_admin.path_name%'

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

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

5. Define the path to your documentation directory in config/packages/_sylius.yaml:

     parameters:
         threebrs_sylius_docs_plugin.docs_path: '%kernel.project_dir%/docs'

Usage

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

• Add your file URLs to docs/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 docs/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.

Development

Usage

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

Testing

After making changes, make sure tests and checks pass:

composer install
bin/phpstan.sh
bin/ecs.sh

License

This library is under the MIT license.

Credits

Developed by 3BRS