Skip to content

Commit 979f77b

Browse files
committed
📝 Update README
1 parent 79d74bb commit 979f77b

3 files changed

Lines changed: 18 additions & 2 deletions

File tree

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,10 @@ conveniently.
4646
"author": "Vanessa",
4747
"url": "https://github.com/siyuan-note/plugin-sample",
4848
"version": "0.0.1",
49+
"displayName": {
50+
"default": "Plugin Sample",
51+
"zh_CN": "插件示例"
52+
},
4953
"description": {
5054
"default": "This is a plugin sample",
5155
"zh_CN": "这是一个插件示例"
@@ -67,14 +71,16 @@ conveniently.
6771
]
6872
}
6973
}
70-
7174
```
7275

7376
* `name`: Plugin name, must be the same as the repo name, and must be unique globally (no duplicate plugin names in the
7477
marketplace)
7578
* `author`: Plugin author name
7679
* `url`: Plugin repo URL
7780
* `version`: Plugin version number, it is recommended to follow the [semver](https://semver.org/) specification
81+
* `displayName`: Template display name, mainly used for display in the marketplace list, supports multiple languages
82+
* `default`: Default language, must exist
83+
* `zh_CN`, `en_US` and other languages: optional, it is recommended to provide at least Chinese and English
7884
* `description`: Plugin description, mainly used for display in the marketplace list, supports multiple languages
7985
* `default`: Default language, must exist
8086
* `zh_CN`, `en_US` and other languages: optional, it is recommended to provide at least Chinese and English

README_zh_CN.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,10 @@
4141
"author": "Vanessa",
4242
"url": "https://github.com/siyuan-note/plugin-sample",
4343
"version": "0.0.1",
44+
"displayName": {
45+
"default": "Plugin Sample",
46+
"zh_CN": "插件示例"
47+
},
4448
"description": {
4549
"default": "This is a plugin sample",
4650
"zh_CN": "这是一个插件示例"
@@ -62,13 +66,15 @@
6266
]
6367
}
6468
}
65-
6669
```
6770

6871
* `name`:插件名称,必须和库名一致,且全局唯一(集市中不能有重名插件)
6972
* `author`:插件作者名
7073
* `url`:插件仓库地址
7174
* `version`:插件版本号,建议遵循 [semver](https://semver.org/lang/zh-CN/) 规范
75+
* `displayName`:模板显示名称,主要用于模板集市列表中显示,支持多语言
76+
* `default`:默认语言,必须存在
77+
* `zh_CN``en_US` 等其他语言:可选,建议至少提供中文和英文
7278
* `description`:插件描述,主要用于插件集市列表中显示,支持多语言
7379
* `default`:默认语言,必须存在
7480
* `zh_CN``en_US` 等其他语言:可选,建议至少提供中文和英文

plugin.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
"author": "Vanessa",
44
"url": "https://github.com/siyuan-note/plugin-sample",
55
"version": "0.0.1",
6+
"displayName": {
7+
"default": "Plugin Sample",
8+
"zh_CN": "插件示例"
9+
},
610
"description": {
711
"default": "This is a plugin sample",
812
"zh_CN": "这是一个插件示例"

0 commit comments

Comments
 (0)