shields-lightweight 是一个轻量级的 npm 包,用于在 Markdown 中为 Github 或其他 Git 托管平台提供自定义徽章。本文将为您提供 shields-lightweight 的使用教程。
安装
安装 shield-lightweight 的命令如下:
npm install shields-lightweight
使用
以下为一个简单的使用示例:
const shieldsLightweight = require('shields-lightweight'); const badge = shieldsLightweight('Badge Text', 'Badge Color');
使用 shieldsLightweight
函数,您可以传入两个参数:文本内容和徽章颜色。
徽章颜色
shields-lightweight 支持多种徽章颜色,下面是一些示例:
- brightgreen
- green
- yellowgreen
- yellow
- orange
- red
- blue
- navy
- lightgrey
- success
- important
- critical
- informational
多个徽章
如果您有多个徽章需要显示,您可以使用 array
作为输入,例如:
const badges = shieldsLightweight(['badge1', 'badge2', 'badge3'], ['red', 'green', 'blue']);
这将创建三个徽章,每个颜色对应数组中的相应位置。
一个完整的示例
-- -------------------- ---- ------- ----- ------------------ - ------------------------------- ----- ------ - ---------- -- --------------- ----- ----------- - ------ --- --------- - --------- - ----------- -- -------- ----- ---------- - ------------------------- ------- --------------- ----- ----------- - -------------------------- ------------- ----------------------- -------------
在以上示例中,我们根据一个状态动态地接收不同颜色的徽章,并与另一个简单的徽章放在一起。
结论
使用 shields-lightweight 创建自定义徽章非常容易,并且可以在 Markdown 和 Git 托管平台上使用。希望本文可以帮助您更好地使用 shields-lightweight。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/79588