Kofi button是一个简单的插件,让您添加一个带有markdown的Kofi按钮。
mkdocs-ko-fi-button-plugin的Python项目详细描述
MkDocs Ko-fi按钮插件
一个MkDocs插件,让您可以轻松地添加带有降价功能的Ko-fi按钮
该插件查找类似{{ko-fi}}
的Jinja样式标记,并将其替换为Ko-fi按钮。可以配置按钮的文本和颜色。在
设置
使用pip安装插件:
pip install mkdocs-ko-fi-button-plugin
激活mkdocs.yml
中的插件:
配置
强制
id
-您的Ko-fi ID.可以在您的Ko-fi配置文件中找到。在
可选
type
-按钮的类型。有效值为“widget”或“image”。默认:小部件color
-按钮的颜色。- If
type == 'widget'
:十六进制格式。默认值:#29abe0 - 如果
type == 'image'
:要么是“蓝色”,“蓝灰色”,“红色”,“绿色”或“黑色”。默认:蓝灰色
- If
text
-Ko-fi按钮上的文本。- If
type == 'widget'
:默认值:“在Ko-fi上支持我” - If
type == 'image'
:图像中的任何文本。在
- If
例如:
plugins: - search - ko-fi-button: id: "my_id" text: "My cool text" color: "#547884"
注意:某些MkDocs主题CSS与小部件样式冲突。如果是这样,并且您不能或不会更新CSS,type
配置很有用。设置为“图像”,它应该正确渲染。但不会有摇摆的咖啡杯。在
高级配置
如果在服务器端更改了Ko-fi javascript,则可以配置路径和函数调用。这将使它仍然能够得到一个工作的Ko-fi按钮小部件,直到这个插件被更新。在
javascript_path
-从https://ko-fi.com/到javascript的相对路径。默认值:“widgets/widget_2.js”javascript_f1
-初始化函数。默认值:“kofiwidget2.init”javascript_f2
-绘制函数。默认值:“kofiwidget2.draw”
注意:这些配置选项只有在type
设置为“widget”时才有效。否则,它们将被忽略。在
- 项目
标签: