🎉 Init commit

siyuan-note · May 7, 2023 · 95e0749 · 95e0749
1 parent 09c6b7a
commit 95e0749
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -25,6 +25,10 @@
   "author": "Vanessa",
   "url": "https://github.com/siyuan-note/icon-sample",
   "version": "0.0.1",
+  "displayName": {
+    "default": "Icon Sample",
+    "zh_CN": "图标示例"
+  },
   "description": {
     "default": "This is a icon sample",
     "zh_CN": "这是一个图标示例"
@@ -46,14 +50,16 @@
     ]
   }
 }
-
 ```
 
 * `name`: Icon name, must be the same as the repo name, and must be unique globally (no duplicate icon names in the
   marketplace)
 * `author`: Icon author name
 * `url`: Icon repo URL
 * `version`: Icon version number, it is recommended to follow the [semver](https://semver.org/) specification
+* `displayName`: Widget display name, mainly used for display in the marketplace list, supports multiple languages
+    * `default`: Default language, must exist
+    * `zh_CN`, `en_US` and other languages: optional, it is recommended to provide at least Chinese and English
 * `description`: Icon description, mainly used for display in the marketplace list, supports multiple languages
     * `default`: Default language, must exist
     * `zh_CN`, `en_US` and other languages: optional, it is recommended to provide at least Chinese and English

diff --git a/README_zh_CN.md b/README_zh_CN.md
@@ -23,6 +23,10 @@
   "author": "Vanessa",
   "url": "https://github.com/siyuan-note/icon-sample",
   "version": "0.0.1",
+  "displayName": {
+    "default": "Icon Sample",
+    "zh_CN": "图标示例"
+  },
   "description": {
     "default": "This is a icon sample",
     "zh_CN": "这是一个图标示例"
@@ -50,6 +54,9 @@
 * `author`：图标作者名
 * `url`：图标仓库地址
 * `version`：图标版本号，建议遵循 [semver](https://semver.org/lang/zh-CN/) 规范
+* `displayName`：模板显示名称，主要用于模板集市列表中显示，支持多语言
+    * `default`：默认语言，必须存在
+    * `zh_CN`、`en_US` 等其他语言：可选，建议至少提供中文和英文
 * `description`：图标描述，主要用于图标集市列表中显示，支持多语言
     * `default`：默认语言，必须存在
     * `zh_CN`、`en_US` 等其他语言：可选，建议至少提供中文和英文

diff --git a/icon.json b/icon.json
@@ -3,6 +3,10 @@
   "author": "Vanessa",
   "url": "https://github.com/siyuan-note/icon-sample",
   "version": "0.0.1",
+  "displayName": {
+    "default": "Icon Sample",
+    "zh_CN": "图标示例"
+  },
   "description": {
     "default": "This is a icon sample",
     "zh_CN": "这是一个图标示例"