amteich/kirby-helpsection

面板视图以显示用户帮助。

安装: 280

依赖项: 0

建议者: 0

安全性: 0

星星: 36

关注者: 3

分支: 1

开放性问题: 0

语言:Vue

类型:kirby 插件

2.0.0 2021-10-11 16:22 UTC

README

Kirby 3 帮助部分

Kirby Version Kirby 3 Pluginkit

为显示用户帮助添加面板视图。帮助页面由预定义的内容文件夹生成。

Kirby Help Section

商业用途和支持

此插件在 MIT 许可下免费。如果您将其用于商业项目或想支持开发,请考虑以下操作

安装

下载

下载并将此存储库复制到 /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 的模板,该模板使用 titleexcerpttext 字段来显示页面。该模板也可以在您的 Kirby 安装中进行覆盖,或者您可以使用自己的模板来为文档页面。

您还可以使用虚拟页面来创建页面和子页面。例如,这个 模型 为页面模板 textformats 生成子页面。

免责声明

此插件提供“原样”且没有任何保证。自行承担使用风险,并在将其用于生产环境之前始终自行测试。

许可证

MIT

鸣谢