doc: README、ISSUE_TEMPLATE 更新

This commit is contained in:
pipipi-pikachu 2022-05-21 11:31:48 +08:00
parent 12fbdcaac9
commit 47450b7b91
2 changed files with 9 additions and 6 deletions

View File

@ -9,13 +9,14 @@ assignees: ''
**注意**
1. 请在提问前先尝试搜索历史 Issue 记录,避免重复的问题。
2. 请确保提问时已经仔细阅读过 README 中的相关事项。
3. 过于随意的 Issue 可能会被直接关闭(表述不清楚、信息不完整、无复现方法)
**问题描述**
请尽量简洁、完整地描述你遇到的bug至少包括以下部分如有必要可提供截图
请尽量简洁、完整地描述你遇到的bug至少包括以下部分如有必要可提供截图甚至视频
1. 问题触发的条件/操作流程
2. 期望表现与实际表现
**环境信息**
至少包含以下部分:
如有必要,可包含以下部分:
1. 系统环境(Mac or Windows)
2. 浏览器环境(如Chrome v89.0.4389.114)

View File

@ -8,7 +8,7 @@
# 👀 前排提示
1. 本项目的目标是打造一个 “在线幻灯片应用” ,而非 “低代码平台”、“H5 编辑器” 或 “图片编辑工具” 等。
2. 本项目的目标受众是<b> Web PPT 开发需要的开发者</b>,提供的链接只是一个演示地址,并不能作为工具使用,也不提供任何在线服务。
2. 本项目的目标受众是<b>【Web 幻灯片】开发需要的开发者</b>,提供的链接只是一个演示地址,并不能作为工具使用,也不提供任何在线服务。
如果你只是需要一个服务或工具,可以选择更优秀和成熟的产品,例如:[石墨文档](https://shimo.im/)、[金山文档](https://www.kdocs.cn/)、[Slidev](https://sli.dev/)、[revealjs](https://revealjs.com/) 等。
3. 本项目是基于 DOM 的渲染方案,好处是简单。但是相比 Canvas 渲染的方案,在复杂场景下性能会存在一定的差距,所以如果你对性能有较高的要求,本项目可能不是一个好的参考方向。
@ -154,12 +154,14 @@ A. 设置在线字体时会下载对应的字体文件,该文件较大,需
A. 作为一个在线幻灯片应用,导出、导入 PPTX 文件是非常重要的功能,但是经过调研发现,该功能实现起来的复杂度远超过了预期。由于个人能力和时间有限,这部分功能只能借助第三方的轮子来完成。
目前导出功能主要基于 [PptxGenJS](https://github.com/gitbrent/PptxGenJS/) 完成能够实现大多数基本元素的导出但还有非常多的缺陷需要一点点完善。同时需要知晓的是1、该功能依赖 PptxGenJS对于该库本身无法实现的部分,我也无能为力2、导出功能的目标只是【导出样式尽可能一致的元素】而不是一比一将网页还原到PPT一些样式差异是必然存在的。
目前导出功能主要基于 [PptxGenJS](https://github.com/gitbrent/PptxGenJS/) 完成能够实现大多数基本元素的导出但还有非常多的缺陷需要一点点完善。同时需要知晓的是1、该功能依赖 PptxGenJS对于该库本身无法实现的部分(如动画),本项目也无能为力2、导出功能的目标只是【导出样式尽可能一致的元素】而不是一比一将网页还原到PPT一些样式差异是必然存在的。
导入功能目前暂时没有合适的解决方案,还在调研和观望中。如果有感兴趣或做过相关内容的朋友,欢迎来 issues 中讨论。
> PS. 我做了一个 [pptx转json](https://github.com/pipipi-pikachu/pptx2json) 的实验,可做参考。
同时补充一点,本项目不是 office PPT 的专属在线编辑器,本质上与 office PPT 没有任何关系。【导入/导出 ppt 文件】只是项目的一个功能而非目的。
**Q. 视频元素支持哪些格式?**
A. 本项目只提供最基础的视频能力正常状态下可以播放video标签本身支持的格式。