amteich / kirby-helpsection
面板视图以显示用户帮助。
2.0.0
2021-10-11 16:22 UTC
Requires
This package is auto-updated.
Last update: 2024-09-23 09:44:28 UTC
README
Kirby 3 帮助部分
为显示用户帮助添加面板视图。帮助页面由预定义的内容文件夹生成。
商业用途和支持
此插件在 MIT 许可下免费。如果您将其用于商业项目或想支持开发,请考虑以下操作
- 捐赠 ☕ 或
- 通过此联盟链接购买 Kirby 许可证 ️️️⭐
安装
下载
下载并将此存储库复制到 /site/plugins/kirby-helpsection
。
Git 子模块
git submodule add https://github.com/amteich/kirby-helpsection.git site/plugins/kirby-helpsection
Composer
composer require amteich/kirby-helpsection
选项
所有选项都需要 amteich.helpsection.
作为前缀。
contentfolder
- 默认:
helpsection
- 此文件夹的内容将加载到面板的帮助视图中
设置
将 examples/content 中的示例结构复制到您的内容文件夹。
content
helpsection
doc.txt
0_contenttypes
doc.txt
image.png
1_text
doc.txt
该插件附带一个名为 doc
的模板,该模板使用 title
、excerpt
和 text
字段来显示页面。该模板也可以在您的 Kirby 安装中进行覆盖,或者您可以使用自己的模板来为文档页面。
您还可以使用虚拟页面来创建页面和子页面。例如,这个 模型 为页面模板 textformats
生成子页面。
免责声明
此插件提供“原样”且没有任何保证。自行承担使用风险,并在将其用于生产环境之前始终自行测试。