From 47450b7b91f8c8cef5a1196c6400a0c72f2dc99f Mon Sep 17 00:00:00 2001 From: pipipi-pikachu Date: Sat, 21 May 2022 11:31:48 +0800 Subject: [PATCH] =?UTF-8?q?doc:=20README=E3=80=81ISSUE=5FTEMPLATE=20?= =?UTF-8?q?=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/ISSUE_TEMPLATE/bug_report.md | 5 +++-- README.md | 10 ++++++---- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index b9df4547..64894f2a 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -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) \ No newline at end of file diff --git a/README.md b/README.md index 14d1757b..8691a304 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # 🎨 PPTist -> 一个基于 Vue3.x + TypeScript 的在线演示文稿（幻灯片）应用，还原了大部分 Office PowerPoint 常用功能，支持 文字、图片、形状、线条、图表、表格、视频、音频、公式 几种最常用的元素类型，每一种元素都拥有高度可编辑能力，同时支持丰富的快捷键和右键菜单，支持导出本地PPTX文件，您可以在此基础上搭建自己的在线幻灯片应用。 +> 一个基于 Vue3.x + TypeScript 的在线演示文稿（幻灯片）应用，还原了大部分 Office PowerPoint 常用功能，支持 文字、图片、形状、线条、图表、表格、视频、音频、公式 几种最常用的元素类型，每一种元素都拥有高度可编辑能力，同时支持丰富的快捷键和右键菜单，支持导出本地 PPTX 文件，您可以在此基础上搭建自己的在线幻灯片应用。 在线体验地址：[https://pipipi-pikachu.github.io/PPTist/](https://pipipi-pikachu.github.io/PPTist/) @@ -8,7 +8,7 @@ # 👀 前排提示 1. 本项目的目标是打造一个 “在线幻灯片应用” ，而非 “低代码平台”、“H5 编辑器” 或 “图片编辑工具” 等。 -2. 本项目的目标受众是有 Web PPT 开发需要的开发者，提供的链接只是一个演示地址，并不能作为工具使用，也不提供任何在线服务。 +2. 本项目的目标受众是有【Web 幻灯片】开发需要的开发者，提供的链接只是一个演示地址，并不能作为工具使用，也不提供任何在线服务。 如果你只是需要一个服务或工具，可以选择更优秀和成熟的产品，例如：[石墨文档](https://shimo.im/)、[金山文档](https://www.kdocs.cn/)、[Slidev](https://sli.dev/)、[revealjs](https://revealjs.com/) 等。 3. 本项目是基于 DOM 的渲染方案，好处是简单。但是相比 Canvas 渲染的方案，在复杂场景下性能会存在一定的差距，所以如果你对性能有较高的要求，本项目可能不是一个好的参考方向。 @@ -152,14 +152,16 @@ A. 设置在线字体时会下载对应的字体文件，该文件较大，需 **Q. 关于导入导出PPTX文件** -A. 作为一个在线幻灯片应用，导出、导入PPTX文件是非常重要的功能，但是经过调研发现，该功能实现起来的复杂度远超过了预期。由于个人能力和时间有限，这部分功能只能借助第三方的轮子来完成。 +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标签本身支持的格式。