PHPackages                             3brs/sylius-documentation-plugin - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Admin Panels](/categories/admin)
4. /
5. 3brs/sylius-documentation-plugin

ActiveSylius-plugin[Admin Panels](/categories/admin)

3brs/sylius-documentation-plugin
================================

Documentation plugin for Sylius Admin Panel.

v2.2.0(3mo ago)079MITPHPPHP ^8.3

Since Jul 22Pushed 3mo agoCompare

[ Source](https://github.com/3BRS/sylius-documentation-plugin)[ Packagist](https://packagist.org/packages/3brs/sylius-documentation-plugin)[ RSS](/packages/3brs-sylius-documentation-plugin/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (38)Versions (8)Used By (0)

 [ ![3BRS Logo](https://camo.githubusercontent.com/bb0c16caf210bea68e0e59fc11e0844dc47097f9aeb8b388c3de5f1414d4d1c0/68747470733a2f2f33627273312e667261312e63646e2e6469676974616c6f6365616e7370616365732e636f6d2f336272732f6c6f676f2f334252532d6c6f676f2d73796c6975732d3230302e706e67) ](https://www.3brs.com)

 Sylius Docs Plugin
 [ ![License](https://camo.githubusercontent.com/b4a06fea928d982f976ee8acff7d7ebaa089b518637b6a3425f727d0b8d5b6d2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f336272732f73796c6975732d646f63756d656e746174696f6e2d706c7567696e) ](https://packagist.org/packages/3brs/sylius-documentation-plugin "License") [ ![Version](https://camo.githubusercontent.com/492a7a8c432e19537c699d8b0004efa2bb9399e538b42af51b7a13674285a20e/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f336272732f73796c6975732d646f63756d656e746174696f6e2d706c7567696e) ](https://packagist.org/packages/3brs/sylius-documentation-plugin "Version") [ ![Build Status](https://camo.githubusercontent.com/55c3d5438e62f5999182ab18a3380454cd0009bc8f3d3434e5e71d6c44329e8d/68747470733a2f2f636972636c6563692e636f6d2f67682f334252532f73796c6975732d646f63756d656e746174696f6e2d706c7567696e2e7376673f7374796c653d736869656c64) ](https://circleci.com/gh/3BRS/sylius-documentation-plugin "Build status")
======================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================================

[](#--sylius-docs-plugin-------------------------)

Features
--------

[](#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

 [![Admin Documentation Index](docs/docs_index_example.png?raw=true)](docs/docs_index_example.png?raw=true)

 [![Admin Documentation Item](./docs/docs_item_example.png?raw=true)](./docs/docs_item_example.png?raw=true)

Installation
------------

[](#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%/behat_docs'
    ```

Usage
-----

[](#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
------------

[](#requirements)

PackageVersionPHP^8.3Sylius^2.1> For Sylius 2.0 support, use version 2.x of this plugin.

Development
-----------

[](#development)

### Usage

[](#usage-1)

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

### Testing

[](#testing)

After making changes, make sure tests and checks pass:

```
make ci
```

License
-------

[](#license)

This library is under the MIT license.

Credits
-------

[](#credits)

Developed by [3BRS](https://3brs.com)

###  Health Score

42

—

FairBetter than 90% of packages

Maintenance82

Actively maintained with recent releases

Popularity10

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 66.7% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~45 days

Total

4

Last Release

94d ago

PHP version history (2 changes)2.0.0PHP ^8.2

v2.2.0PHP ^8.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/ab23998c28b111996e4b3357f20929d6904a97ac21724750e1dfafd6a09791e4?d=identicon)[ondrej-kuhnel](/maintainers/ondrej-kuhnel)

---

Top Contributors

[![jaroslavtyc](https://avatars.githubusercontent.com/u/2290225?v=4)](https://github.com/jaroslavtyc "jaroslavtyc (6 commits)")[![AdhamKandeel27](https://avatars.githubusercontent.com/u/108978262?v=4)](https://github.com/AdhamKandeel27 "AdhamKandeel27 (1 commits)")[![hornofj](https://avatars.githubusercontent.com/u/2500352?v=4)](https://github.com/hornofj "hornofj (1 commits)")[![ondrej-kuhnel](https://avatars.githubusercontent.com/u/6840281?v=4)](https://github.com/ondrej-kuhnel "ondrej-kuhnel (1 commits)")

---

Tags

documentationsyliussylius-plugin

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan, Rector

Code StyleECS

Type Coverage Yes

### Embed Badge

![Health badge](/badges/3brs-sylius-documentation-plugin/health.svg)

```
[![Health](https://phpackages.com/badges/3brs-sylius-documentation-plugin/health.svg)](https://phpackages.com/packages/3brs-sylius-documentation-plugin)
```

###  Alternatives

[monsieurbiz/sylius-settings-plugin

Add a settings panel to your Sylius.

27192.5k8](/packages/monsieurbiz-sylius-settings-plugin)[monsieurbiz/sylius-rich-editor-plugin

A Rich Editor plugin for Sylius.

75380.8k6](/packages/monsieurbiz-sylius-rich-editor-plugin)[monsieurbiz/sylius-homepage-plugin

Add a homepage management to your Sylius using the Rich Editor.

1460.7k1](/packages/monsieurbiz-sylius-homepage-plugin)[webgriffe/sylius-akeneo-plugin

Plugin allowing to import products data from Akeneo PIM to your Sylius store.

2477.8k](/packages/webgriffe-sylius-akeneo-plugin)[webgriffe/sylius-table-rate-shipping-plugin

Provides table rate shipping calculator.

1490.4k](/packages/webgriffe-sylius-table-rate-shipping-plugin)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)