提交 20c55c09 编写于 作者: DCloud-WZF's avatar DCloud-WZF 💬

chore: update readme.md

上级 64442b00
......@@ -24,16 +24,19 @@ npx husky@9.0.11
#### pages.json
**注意:**\
创建 `component``API``CSS` 示例页面时,如果该示例页面需要在对应 `tabBar` 菜单中展示,`path` 命名需要遵循以下规则:
- pages/component/component-name/component-name
- pages/API/api-name/api-name
- pages/CSS/css-name/css-name
所以,如果是扩展示例,比如针对 `button type 属性` 的示例,`path` 可以是:`pages/component/button/button-type`\
如果想要该示例页面在菜单中显示,则需要调整为:`pages/component/button/button/type`
如果想要该示例页面在菜单中显示,则需要调整为:`pages/component/button/button/type`\
如果 API 示例为多个 API 的组合,此时无法以单一 API 名称命名,可以使用 `pages/API/xxx/xxx` 命名示例页面,但在维护 [syntaxdoc](http://git.dcloud.io/uni-app-x/syntaxdoc) `modules.json` 时,需要通过 `items` 节点关联对应 API 信息。\
增加上述示例页面时,相同类型的页面要放在一起,不要随意放置在最后或最前!
**注意:**增加上述示例页面时,不需要基于平台兼容性补充条件编译,代码提交后,会基于 [syntaxdoc](http://git.dcloud.io/uni-app-x/syntaxdoc) 仓库中的平台兼容性信息,自动生成对应的条件编译代码,并更新 `pages.json`
增加上述示例页面时,不需要基于平台兼容性补充条件编译,代码提交后,会基于 [syntaxdoc](http://git.dcloud.io/uni-app-x/syntaxdoc) 仓库中的平台兼容性信息,自动生成对应的条件编译代码,并更新 `pages.json`
`pages.json` 中增加后页面配置后,需要在 [syntaxdoc](http://git.dcloud.io/uni-app-x/syntaxdoc) 仓库的 `modules.json` 中维护目录信息。
......@@ -41,4 +44,4 @@ npx husky@9.0.11
`page.group` 属性中的数字代表该页面在 `pages.json/groups` 中对应位置的下标,
`pages.json/groups` 中维护了基于 `syntaxdoc/modules.json` 获取的目录信息。
**注意:**调整现有页面的路径或平台兼容性,或移除页面时,如果该页面涉及截图对比测试,需要同时调整 `pages/pages.test.js` 中的页面地址。
调整现有页面的路径或平台兼容性,或移除页面时,如果该页面涉及截图对比测试,需要同时调整 `pages/pages.test.js` 中的页面地址。
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册