qossmic/twig-doc-bundle

包含 twig 组件的 Storybook

安装: 40

依赖: 0

建议者: 0

安全性: 0

星标: 2

关注者: 5

分支: 0

公开问题: 7

类型:symfony-bundle

v0.0.3 2024-04-22 07:55 UTC

This package is auto-updated.

Last update: 2024-09-15 14:47:50 UTC


README

Image 由 qossmic 提供支持!

  1. 请注意!
  2. 安装
  3. 配置
    1. 包配置
    2. 组件配置
  4. 路由
  5. 自定义
  6. 用法

实验性包

重要:这是一个实验性版本,可能会发生重大变化。因此,在发布稳定版本之前,您在更新时可能会遇到破坏性更改。

  • 不良模板:由于前端能力的不足,模板非常“基础”
    • 但在每个 Symfony 包中,您都可以轻松覆盖它们并创建自己的模板 :-)
  • 文档不完整
  • 没有翻译(目前)

允许您为 Twig 组件创建概述,无论是 UX-Components、UX-Live-Components 还是简单的片段模板。

组件将按类别和可选子类别分组。

安装

由于包尚未公开发布,您需要在 composer.json 文件中添加一个存储库。

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/qossmic/twig-doc-bundle.git"
    }
  ]
}

安装包

composer req qossmic/twig-doc-bundle

路由

由于 symfony 从不为包创建路由,您需要自行配置!

创建一个配置文件:config/routes/twig_doc.yaml

twig_doc:
  resource: '@TwigDocBundle/config/routing/documentation.xml'
  prefix: /twig/doc
  # or for localized: prefix: /{_locale}/twig/doc/

自定义设计

要自定义文档的设计,您可以在项目中覆盖包中的任何模板。

参见:如何覆盖包的任何部分