basilicom / pimcore-readme-viewer-bundle
此插件允许在Pimcore中渲染readme文件。
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
README
用例/摘要
如果一个项目在readme文件或其他工具(如Confluence)中进行了文档说明,那么在某个时候,保持所有源文件更新的难度会很大。因此,我们创建了此readme查看器,以便代码文档的更新也可以部署并供Pimcore用户查看。
可以通过Pimcore后端菜单项或https://your-domain/admin/readme
查看文档。
安装
composer require basilicom/pimcore-readme-viewer-bundle
配置
pimcore_readme_viewer:
entry: '%kernel.project_dir%/docs/readme.md'
theme: light|dark
作者:Alexander Heidrich (Basilicom GmbH)
许可:GPL v3