Obsidian 插件:Icons
插件名片
概述
将图标添加到您的 Obsidian 中,扩充默认支持的图标集。
原文出处
下面自述文件的来源于 Readme
Readme(翻译)
下面是 obsidian-icons-plugin 插件的自述翻译
Obsidian 图标插件
注意: 如果遇到任何错误,请在 GitHub 上开启一个新的问题报告。
为您的 Obsidian 笔记添加图标。支持的图标集包括:
- Remix Icon - 2172 个图标
- FontAwesome (Free) - 1560 个图标
- 路线图中包括更多的图标集
您可以在 _ 图标插件 _ 设置中切换要显示的图标集。
该插件使用 react-icons 通过 Markdown 后处理器来渲染图标。灵感来自于 obsidian-citation-plugin,基于 obsidian-sample-plugin。
演示和截图
一个演示视频,展示了图标选择器和渲染的 Markdown。
从图标选择器中选择任何图标(在设置中选择性地激活图标包)。
渲染的 Markdown 将相应地显示图标。
如何报告错误
由于这是一个实验性的插件,预计会出现错误。请在该存储库中打开一个问题,并详细描述您遇到的错误。
图标集 | 许可证 | 版本 | 数量 |
---|---|---|---|
Font Awesome | CC BY 4.0许可证 | 5.12.1 | 1560 |
Remix Icon | Apache License Version 2.0 | 2.5.0 | 2172 |
自定义图标
为了自定义图标以更改其颜色、大小等,您应该创建一个 CSS 片段。
要做到这一点,请按照以下步骤操作:
-
转到设置 ->外观 ->CSS 片段
-
打开 CSS 片段选项,然后单击文件夹以导航到其文件夹。
-
创建一个名为 icons.css 的新文件
-
在您喜欢的文本编辑器中打开 icons.css
-
添加以下内容:
.obsidian-icon { ...更改在此处进行。 }
-
返回到设置 ->外观 ->CSS 片段
-
单击重新加载按钮
-
应该出现一个名为“icons”的按钮,将其打开。
您的更改现在将被应用,并且您可以在需要时编辑该文件。
开发
开发步骤
- 将此仓库克隆到
./your-obsidian-vault/.obsidian/plugins/
- 运行
yarn
安装依赖 - 运行
npm run dev
以启动编译并进入监听模式。
发布新版本
- 使用新的版本号更新你的
manifest.json
,例如1.0.1
,并指定你的插件所需的最低 Obsidian 版本。 - 在你的
versions.json
文件中更新"new-plugin-version": "minimum-obsidian-version"
,这样旧版本的 Obsidian 就可以下载与其兼容的旧版本插件。 - 使用你的新版本号作为 “Tag version” 创建新的 GitHub 发布。使用精确的版本号,不要包含前缀
v
。参考这里的示例:https://github.com/obsidianmd/obsidian-sample-plugin/releases - 将
manifest.json
、main.js
、styles.css
文件作为二进制附件上传。 - 发布该版本。
- 为方便起见,使用
make release
命令。
手动安装插件
- 将
main.js
、styles.css
、manifest.json
复制到你的 vault 文件夹VaultFolder/.obsidian/plugins/obsidian-icons-plugin/
中。
API 文档
反馈交流
其他渠道
版权声明
版权声明:所有 PKMer 文章如果需要转载,请附上原文出处链接。