README

要求: Kirby 3

咖啡，啤酒等。

此插件免费。但是，为了表示您的支持，尤其是如果您将其用于商业项目，您欢迎（强烈鼓励）

• 捐款 🍻 或者
• 买我 ☕☕ 或者
• 使用此联盟链接购买 Kirby 许可证

文档

目的

对于由 Kirby3 驱动的网站，此插件（omz13/badges）提供了一个名为 badge 的 KirbyTag，允许在页面中渲染徽章。

• 此插件是围绕 PHP Badges Library 的便利包装。
• 由于它附带合理的默认值，因此不需要进行任何配置。
• 可以在配置文件中指定渲染样式，并可以针对每个标签进行覆盖。
• 可以在配置文件中指定值的颜色，并可以针对每个标签进行覆盖。
• 如果您忘记在标签中提供必要的键和/或值数据，将提供合理的默认值。
• 徽章在本地渲染，提供为 SVG 图像，并包装在一个具有可选 class 的 <div> 中。

路线图

以下是非约束性的进一步功能和实施说明列表

• 页面级功能
• 在 README 中放入一两个笑话
• 在 README 中使用单词 epistemological 来混淆每个人（除了那些做过或正在做哲学或艺术史的人）。

安装

根据您的认识论模型选择以下之一

• composer require omz13/kirby3-badges；插件将自动出现在 site/plugins 中。
• 下载最新版本的 zip 文件 - master.zip - 并将其内容复制到您的 site/plugins/kirby3-badges。
• git submodule add https://github.com/omz13/kirby3-badges.git site/plugins/kirby3-badges.

记录在案：通过 composer 安装很酷；支持通过 zip 和子模块安装绝对痛苦，尤其是因为我是一个通过 composer 安装的人，所以请感觉内疚地给我咖啡、啤酒等，因为这是为了 您 的好处，而不是我的好处（而且是的，我宁愿花时间在温暖阳光明媚的地方，而不是蜷缩在键盘前，外面下着雪，温度计显示没有超过 0°C 的倾向）。

配置

可以使用以下机制来修改插件的行为。

通过 config.php

在您的站点的 site/config/config.php 中，可以使用以下带有 omz13.badges. 前缀的条目

• style - 可选 - 应用渲染样式的名称。

  可能的值有

  • flat（未指定时默认值）
  • flat-square
  • plastic

• color - 可选 - 用于徽章名称的名称或RGBHEX值。

  未指定时，默认为428F7E。

• class - 可选 - 徽章代码将被包裹在一个指定了classname的<DIV>中。

  未指定时，<DIV>包装器没有类。

例如

<?php

return [
  'omz13.badges.style' => 'plastic',
  'omz13.badges.class' => 'badge',
  ],
];

使用

"(badge:" key value [ color [ "style:"style ] ] ")"

在编写内容时，此插件提供一个新的标签 badge，该标签有两个必填参数，用于指定徽章的key和value；可选的第三个参数指定值的颜色，可以是名称颜色（例如 red）或RGBhex（例如 428F7E）。

可以可选地使用 style 属性来覆盖默认样式（参看 配置 中的 style）。

参数可以由空格（ ）、逗号（,）或分号（;）分隔。

如果未提供key，则使用???。

如果未提供value，则使用???。

示例

使用配置中的（隐式）样式或显式设置

  - (badge: style, implicit - from configuration)
  - (badge: style, explicit flat style:flat)
  - (badge: style, explicit plastic style:plastic)
  - (badge: style, explicit flat-square style:flat-square)

应用一些颜色

- (badge: copyright ; public domain ; green  )
- (badge: stability: unstable orange)
- (badge: licence MIT)
- (badge: statis YES yellow)

缺少key和/或value

- (badge:)
- (badge: wibble)

免责声明

此插件提供“原样”且无任何保证。请在自己的风险中使用它，并在将插件用于生产环境之前自行测试。如果您发现任何问题，请创建新问题。

许可证

MIT

禁止您在任何宣传种族主义、性别歧视、同性恋恐惧症、动物虐待、暴力或其他任何形式仇恨言辞的项目中使用此插件。