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