From 608fd9bdbb3abba3ae2c901a0a18f59139024254 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E8=91=9B=E4=BA=9A=E8=8A=B3?= Date: Fri, 4 Aug 2023 07:18:55 +0000 Subject: [PATCH] update zh-cn/contribute/template/js-template.md. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: 葛亚芳 --- zh-cn/contribute/template/js-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/contribute/template/js-template.md b/zh-cn/contribute/template/js-template.md index 69eaca7638..b1f6b75c9d 100644 --- a/zh-cn/contribute/template/js-template.md +++ b/zh-cn/contribute/template/js-template.md @@ -7,7 +7,7 @@ | | 说明项 | 细则 | | ---- | --------------------------------- | ------------------------------------------------------------ | | 1 | 客户化写作基本要求 | **写作中，请变身开发者，对于开发者使用该API时所需的使用场景、参数选取原则、开发建议/经验、示例等信息进行清晰描述，达到指导开发者顺利使用本API进行开发的目标。** | -| 2 | 上传路径 | markdown文件：docs/zh-cn/application-dev/reference/apis
图片路径：docs/zh-cn/application-dev/reference/apis/figures，并在markdown文件中通过路径`![](figures/xxx.jpg)`或`![](figures/xxx.png)`引用。 | +| 2 | 上传路径 | markdown文件：docs/zh-cn/application-dev/reference/apis
图片路径：docs/zh-cn/application-dev/reference/apis/figures，并在markdown文件中通过路径\![]\(figures/xxx.jpg)或\![]\(figures/xxx.png)引用。 | | 3 | 文件命名 | 一个d.ts对应一个js api文档，文件名称应与模块名称保持一致，格式为：**js-apis-模块名.md**。
示例：
媒体@ohos.multimedia.audio，文件命名为：js-apis-audio.md
电话@ohos.telephony.sms，文件命名为：js-apis-sms.md | | 4 | 目录修改 | 新增文件，需要修改对应的Readme，即`docs/zh-cn/application-dev/reference/apis/Readme-CN.md`。
目录按字母顺序排列。 | | 5 | 文档结构 | - 模块说明
- 起始版本说明
- 导入模块/使用说明
- 接口（属性、常量、方法、枚举、自定义类型）
描述顺序和代码保持一致，如果某些接口具有逻辑顺序，请注意排列。 | -- GitLab