diff --git a/README.md b/README.md index 7aa93982..9ba66e95 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,40 @@ # kkFileView -此项目为文件文档在线预览项目解决方案，对标业内付费产品有【[永中office](http://dcs.yozosoft.com/)】【[office365](http://www.officeweb365.com/)】【[idocv](https://www.idocv.com/)】等，在取得公司高层同意后以Apache协议开源出来反哺社区，在此特别感谢@唐老大的支持以及@端木详笑的贡献。该项目使用流行的spring boot搭建，易上手和部署，基本支持主流办公文档的在线预览，如doc,docx,Excel,pdf,txt,zip,rar,图片等等 +文档在线预览项目解决方案，项目使用流行的spring boot搭建，易上手和部署。万能的文件预览开源项目，基本支持主流文档格式预览，如： +1. 支持 doc, docx, xls, xlsx, xlsm, ppt, pptx, csv, tsv 等 Office 办公文档 +2. 支持 wps, dps, et 等国产 WPS Office 办公文档 +3. 支持 odt, ods, ots, odp, otp, six, ott, fodt, fods 等OpenOffice、LibreOffice 办公文档 +4. 支持 vsd, vsdx 等 Visio 流程图文件 +5. 支持 wmf, emf 等 Windows 系统图像文件 +6. 支持 psd 等 Photoshop 软件模型文件 +7. 支持 pdf ,ofd, rtf 等文档 +8. 支持 xmind 软件模型文件 +9. 支持 eml, epub 文档类型文件 +10. 支持 obj, 3ds, stl, ply, gltf, glb, off, 3dm, fbx, dae, wrl, 3mf, ifc, brep, step, iges, fcstd, bim 等 3D 模型文件 +11. 支持 dwg, dxf 等 CAD 模型文件 +12. 支持 txt, xml(渲染), md(渲染), java, php, py, js, css 等所有纯文本 +13. 支持 zip, rar, jar, tar, gzip, 7z 等压缩包 +14. 支持 jpg, jpeg, png, gif, bmp, ico, jfif, webp 等图片预览（翻转，缩放，镜像） +15. 支持 tif, tiff 图信息模型文件 +16. 支持 tga 图像格式文件 +17. 支持 svg 矢量图像格式文件 +18. 支持 avi, mov, wmv, mkv, 3gp, rm 等众多音视频格式文件 + +> 基于当前良好的架构模式，支持的文件类型在进一步丰富中 ### 项目特性 -1. 支持 office, pdf, cad 等办公文档 -1. 支持 txt, xml(渲染), md(渲染), java, php, py, js, css 等所有纯文本 -1. 支持 zip, rar, jar, tar, gzip 等压缩包 -1. 支持 jpg, jpeg, png, gif, tif, tiff 等图片预览（翻转，缩放，镜像） -1. 使用 spring-boot 开发，预览服务搭建部署非常简便 -1. rest 接口提供服务，跨语言、跨平台特性(java,php,python,go,php，....)都支持，应用接入简单方便 -1. 抽象预览服务接口，方便二次开发，非常方便添加其他类型文件预览支持 -1. 最最重要 Apache 协议开源，代码 pull 下来想干嘛就干嘛 +- 使用 spring-boot 开发，预览服务搭建部署非常简便 +- rest 接口提供服务，跨语言、跨平台特性(java,php,python,go,php，....)都支持，应用接入简单方便 +- 抽象预览服务接口，方便二次开发，非常方便添加其他类型文件预览支持 +- 最最重要 Apache 协议开源，代码 pull 下来想干嘛就干嘛 ### 官网及文档 -地址：[https://kkfileview.keking.cn](https://kkfileview.keking.cn) +地址：[https://kkview.cn](https://kkview.cn/) ### 在线体验 > 请善待公共服务，会不定时停用 -地址：[https://file.keking.cn](https://file.keking.cn) +地址：[https://kkview.cn/preview/index](https://kkview.cn/preview/index) ### 项目文档（Project documentation） 1. 详细wiki文档：https://gitee.com/kekingcn/file-online-preview/wikis/pages @@ -35,59 +51,59 @@ #### 1. 文本预览 支持所有类型的文本文档预览， 由于文本文档类型过多，无法全部枚举，默认开启的类型如下 txt,html,htm,asp,jsp,xml,json,properties,md,gitignore,log,java,py,c,cpp,sql,sh,bat,m,bas,prg,cmd 文本预览效果如下 -![文本预览效果如下](https://kkfileview.keking.cn/img/preview/preview-text.png) +![文本预览效果如下](https://kkview.cn/img/preview/preview-text.png) #### 2. 图片预览 支持jpg，jpeg，png，gif等图片预览（翻转，缩放，镜像），预览效果如下 -![图片预览](https://kkfileview.keking.cn/img/preview/preview-image.png) +![图片预览](https://kkview.cn/img/preview/preview-image.png) #### 3. word文档预览 支持doc，docx文档预览，word预览有两种模式：一种是每页word转为图片预览，另一种是整个word文档转成pdf，再预览pdf。两种模式的适用场景如下 * 图片预览：word文件大，前台加载整个pdf过慢 * pdf预览：内网访问，加载pdf快 图片预览模式预览效果如下 -![word文档预览1](https://kkfileview.keking.cn/img/preview/preview-doc-image.png) +![word文档预览1](https://kkview.cn/img/preview/preview-doc-image.png) pdf预览模式预览效果如下 -![word文档预览2](https://kkfileview.keking.cn/img/preview/preview-doc-pdf.png) +![word文档预览2](https://kkview.cn/img/preview/preview-doc-pdf.png) #### 4. ppt文档预览 支持ppt，pptx文档预览，和word文档一样，有两种预览模式 图片预览模式预览效果如下 -![ppt文档预览1](https://kkfileview.keking.cn/img/preview/preview-ppt-image.png) +![ppt文档预览1](https://kkview.cn/img/preview/preview-ppt-image.png) pdf预览模式预览效果如下 -![ppt文档预览2](https://kkfileview.keking.cn/img/preview/preview-ppt-pdf.png) +![ppt文档预览2](https://kkview.cn/img/preview/preview-ppt-pdf.png) #### 5. pdf文档预览 支持pdf文档预览，和word文档一样，有两种预览模式 图片预览模式预览效果如下 -![pdf文档预览1](https://kkfileview.keking.cn/img/preview/preview-pdf-image.png) +![pdf文档预览1](https://kkview.cn/img/preview/preview-pdf-image.png) pdf预览模式预览效果如下 -![pdf文档预览2](https://kkfileview.keking.cn/img/preview/preview-pdf-pdf.png) +![pdf文档预览2](https://kkview.cn/img/preview/preview-pdf-pdf.png) #### 6. excel文档预览 支持xls，xlsx文档预览，预览效果如下 -![excel文档预览](https://kkfileview.keking.cn/img/preview/preview-xls.png) +![excel文档预览](https://kkview.cn/img/preview/preview-xls.png) #### 7. 压缩文件预览 支持zip,rar,jar,tar,gzip等压缩包，预览效果如下 -![压缩文件预览1](https://kkfileview.keking.cn/img/preview/preview-zip.png) +![压缩文件预览1](https://kkview.cn/img/preview/preview-zip.png) 可点击压缩包中的文件名，直接预览文件，预览效果如下 -![压缩文件预览2](https://kkfileview.keking.cn/img/preview/preview-zip-inner.png) +![压缩文件预览2](https://kkview.cn/img/preview/preview-zip-inner.png) #### 8. 多媒体文件预览 理论上支持所有的视频、音频文件，由于无法枚举所有文件格式，默认开启的类型如下 mp3,wav,mp4,flv 视频预览效果如下 -![多媒体文件预览1](https://kkfileview.keking.cn/img/preview/preview-video.png) +![多媒体文件预览1](https://kkview.cn/img/preview/preview-video.png) 音频预览效果如下 -![多媒体文件预览2](https://kkfileview.keking.cn/img/preview/preview-audio.png) +![多媒体文件预览2](https://kkview.cn/img/preview/preview-audio.png) #### 9. CAD文档预览 支持CAD dwg文档预览，和word文档一样，有两种预览模式 图片预览模式预览效果如下 -![cad文档预览1](https://kkfileview.keking.cn/img/preview/preview-cad-image.png) +![cad文档预览1](https://kkview.cn/img/preview/preview-cad-image.png) pdf预览模式预览效果如下 -![cad文档预览2](https://kkfileview.keking.cn/img/preview/preview-cad-pdf.png) +![cad文档预览2](https://kkview.cn/img/preview/preview-cad-pdf.png) 考虑说明篇幅原因，就不贴其他格式文件的预览效果了，感兴趣的可以参考下面的实例搭建下 ### 快速开始 @@ -199,7 +215,7 @@ ofd 类型文件支持版本，本次版本重要功能均由社区开发贡献 12. 修复url中包含特殊字符可能会引起的预览异常 13. 修复转换文件队列addTask异常 14. 修复其他已经问题 -15. 官网建设：[https://kkfileview.keking.cn](https://kkfileview.keking.cn) +15. 官网建设：[https://kkview.cn](https://kkview.cn/) 16. 官方Docker镜像仓库建设：[https://hub.docker.com/r/keking/kkfileview](https://hub.docker.com/r/keking/kkfileview) > 2019年06月18日 ： @@ -257,3 +273,9 @@ epub 引用于 [ epub.js](https://github.com/futurepress/epub.js) 开源协议 #### GitHub [![Stargazers over time](https://starchart.cc/kekingcn/kkFileView.svg)](https://starchart.cc/kekingcn/kkFileView) + +### 鸣谢 +- 本项目诞生于[凯京集团]，在取得公司高层同意后以 Apache 协议开源出来反哺社区，在此特别感谢凯京集团，以及集团领导@唐老大的支持、@端木详笑的贡献。 +- 本项目已脱离公司由[KK开源社区]维护发展壮大，感谢所有给 kkFileView 提 Issue 、Pr 开发者 +- 本项目引入的第三方组件已在 '关于引用' 列表列出，感谢这些项目，让 kkFileView 更出色 +