diff --git a/docs/zh/how-to-contribute.mdx b/docs/zh/how-to-contribute.mdx index 303b4e96d..5cd1b7687 100644 --- a/docs/zh/how-to-contribute.mdx +++ b/docs/zh/how-to-contribute.mdx @@ -208,20 +208,29 @@ engine.resourceManager ``` -### 嵌入示例 +### 示例 -在之前,你使用的是 `{:html}` 语法来嵌入的示例。新版的官网对此语法也做了兼容。但后续嵌入示例时推荐使用下面新的语法。毕竟,这里嵌入的示例只是一个 iframe 而已。 +#### 编写示例代码 + +我们现在提供两种方式让你组织示例代码: + +- 在 `examples/` 文件夹下新建 `.ts` 示例文件来组织示例代码 +- 在 `examples/` 文件夹下新建一个 **示例文件夹**,最后通过 `示例文件夹/index.ts` 来暴露示例代码 + +#### 嵌入示例 ````mdx filename="light.mdx" ... Ambient light emits from all directions and enters the eye, as shown in the example below: - + ... ```` + + ## 新增文档 新增文档相较于之前可能多了一些步骤(在某些情况下)。需要提前说明的是,在新的官网中,文件路径即是路由。同时文档的顺序以及标题需要使用 `_meta.json` 进行配置。