basilicom/pimcore-readme-viewer-bundle

This bundle allows to render a readme file inside of Pimcore.

v0.1.3 2024-09-17 13:43 UTC

Requires

• php: >=8.1
• league/commonmark: ^2.5
• pimcore/pimcore: >=11

Requires (Dev)

• phpunit/phpunit: ^9.0

GPL-3.0-or-later

• Alexander Heidrich
• Basilicom GmbH

• markdown
• readme
• pimcore

README

Usecase / Summary

If a project is documented in a readme file, a tool like Confluence or other places, at some point it will be hard to keep all sources up to date. Therefor we created this readme viewer, so updates in the code documentation can also be deployed and made visible for Pimcore users.

The documentation can be viewed via Pimcore Backend Menu Item or https://your-domain/admin/readme

Installation

composer require basilicom/pimcore-readme-viewer-bundle

Configuration

pimcore_readme_viewer:
  entry: '%kernel.project_dir%/docs/readme.md'
  theme: light|dark

Author: Alexander Heidrich (Basilicom GmbH)
License: GPL v3