toppic
当前位置: 首页> 穿越小说> 官网文档新版本上线开测啦!新增离线电子书、API关键词搜索等特性

官网文档新版本上线开测啦!新增离线电子书、API关键词搜索等特性

2021-08-13 13:13:57

为了解决之前文档网站的各种使用体验问题,在 1.6 版本上线之际我们使用了 gitbook  https://www.gitbook.com 作为文档的生成工具,并增加了很多新的特性,现在新版文档网站已经上线,欢迎大家测试并反馈意见:


- [Cocos Creator 手册文档]  

http://docs.cocos.com/creator/manual/zh

- [Cocos Creator API 参考]  

http://docs.cocos.com/creator/api/zh


注意:测试阶段的文档地址可能会在之后发生变化,正式上线后会以 cocos.com 官网的链接地址为准。


离线电子书


凭借 gitbook 的强大功能,现在我们可以很容易的生成手册文档的电子书版本,对于网络环境不好的用户来说可以下载电子书随时查阅:


- [PDF 格式]

http://download.cocos.com/CocosCreator/docs/cocos-creator-manual-v1.6.x_zh.pdf


- [ePub 格式]

http://download.cocos.com/CocosCreator/docs/cocos-creator-manual-v1.6.x_zh.epub


反馈问题更容易


我们在每个页面增加了反馈问题的悬浮按钮,当遇到文档内容错误、缺失,或表述不明的情况,大家都可以很方便的点击按钮来提交 github issue。



框选有问题的文本并点击反馈按钮后,就会自动打开文档网站的 github issue 页面。



在 issue 信息中已经自动包括了刚才页面的链接和高亮的文本,接下来只要在后面补充你的问题然后点击绿色的 「Submit new issue」按钮即可成功提交反馈了!


欢迎大家在阅读文档时随时把问题和建议通过这种方式发给我们,我们会持续对文档进行补充和优化!


移动设备体验优化


新的文档网站使用了对移动设备友好的模板,用手机查文档更方便了。



全文搜索和API关键字搜索


新版文档全面强化了搜索功能,在左侧搜索栏输入任何你想了解的话题,会立刻在全部文档正文和标题中对搜索内容进行匹配并返回结果。



点击任何搜索结果进入页面后,搜索的关键词会保持高亮状态。



在 API 文档网站搜索时,会优先显示和关键词完全匹配的 API 成员或类名。



API附带源码链接


新的 API 文档中,每个类和成员的描述部分都会附带该 API 在 github 上的在线地址,并精确到行。



对于比较难理解用法的 API,只要点击链接前往在线源码查看内部逻辑,能够对我们使用时遇到的问题提供很大的帮助。 如果阅读源码后发现引擎实现有问题,请顺便在 github 页面为我们提出 issue 或 pull request!


API文档添加Aditor和Asset DB部分 


目前面向扩展开发者的文档和教程还在做进一步的计划和筹备中,在此之前大家可以在 API 文档网站搜索 `Editor` 和 `AssetDB` 关键字,查阅这两个模块已经放出的 API 说明。


欢迎补充和反馈!



戳原文,进帖交流!

友情链接