Skip to content

Commit 384315d

Browse files
committed
docs: require mdi- prefix for plugin icon field
1 parent d036e00 commit 384315d

2 files changed

Lines changed: 7 additions & 3 deletions

File tree

docs/en/dev/star/plugin-new.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,11 @@ If your plugin provides a WebUI page (a `pages/` directory), the sidebar automat
6969
icon: brain
7070
```
7171

72-
Copy the icon name from the MDI website. If `icon` is not set, the sidebar uses a default icon.
72+
Copy the icon name from the MDI website and add an `mdi-` prefix:
73+
74+
```yaml
75+
icon: mdi-brain
76+
```
7377

7478
### Bundle Skills with a Plugin (Optional)
7579

docs/zh/dev/star/plugin-new.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,10 +67,10 @@ short_desc: 一句话介绍你的插件。
6767
6868
如果你的插件提供了 WebUI 页面(`pages/` 目录),侧边栏会在「插件页面」分组下自动显示入口。你可以通过 `metadata.yaml` 中的 `icon` 字段指定一个图标,作为该入口的侧边栏图标。
6969

70-
图标名称来自 [Material Design Icons](https://pictogrammers.com/library/mdi/),选择图标后复制其名称即可
70+
图标名称来自 [Material Design Icons](https://pictogrammers.com/library/mdi/),选择图标后复制其名称,加上 `mdi-` 前缀即可
7171

7272
```yaml
73-
icon: brain
73+
icon: mdi-brain
7474
```
7575

7676
如果不设置 `icon`,侧边栏会使用默认图标。

0 commit comments

Comments
 (0)