当前位置:   article > 正文

推荐一个开源在线文档实时编辑器 Etherpad 以及 自制一个在线接口文档html模板页面_开源的在线文档

开源的在线文档

一、推荐一个开源在线文档实时编辑器 Etherpad

    之前使用的飞书在线文档实时编辑,功能很强大,也很好用。新公司里这些基础服务都不怎么好用,网上当然有一些共享文档的第三方服务,包括腾讯文档、石墨文档等。但自己就想看看有没有这方面的开源产品。找了找还真发现一个EtherPad开源产品。使用了一下,觉得小团队的话体验还可以。

    EtherPad的git官网地址和文档地址如下:

https://gitee.com/mirrors/Etherpad/blob/develop/doc/docker.md
Etherpad: Etherpad是一款真正实时的协作编辑器,可扩展到数千个同步实时用户。 与所有其他协作工具不同,Etherpad提供完全保真的数据导出和可移植性,使其完全符合GDPR标准

使用docker安装比较方便。 

  1. root@kermit:~# docker pull etherpad/etherpad
  2. Using default tag: latest
  3. latest: Pulling from etherpad/etherpad
  4. bb79b6b2107f: Pull complete
  5. 99ce436c3449: Pull complete
  6. ......
  7. Status: Downloaded newer image for etherpad/etherpad:latest
  8. docker.io/etherpad/etherpad:latest
  9. root@kermit:~# docker run -d -u root --privileged=true \
  10. --name etherpad \
  11. -p 8000:9001 \
  12. -e 'ADMIN_PASSWORD=test123' \
  13. -v /opt/etherpad-lite:/opt/etherpad-lite \
  14. etherpad/etherpad
  15. 154429a81681bdd2ab668fb8d7a3d3056b1c8da304398e486a6d7233dd486dad
  16. root@kermit:~# docker ps -a
  17. CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
  18. 154429a81681 etherpad/etherpad "docker-entrypoint.s…" 18 seconds ago Up 10 seconds 0.0.0.0:8000->9001/tcp etherpad

    启动成功之后,就能使用8000端口访问服务了,然后可以尝试同时开启两个浏览器窗口编辑内容,可以发现编辑内容会实时同步。不过真正要用到项目中的,还需要进入到管理界面安装更多的插件,上面安装的时候带的ADMIN_PASSWORD就是管理员的密码,账号是admin。更多插件配置参见这里:在线协作编辑器EtherPad使用说明_etherpad 二次开发-CSDN博客

二、自制一个在线接口文档html模板页面

    因为经常要给合作方做接口说明和展示,很早就写了这样一个简单的接口文档,后来在其它公司里也有用到,觉得还挺有用,今天对接口文档进行了功能完善,加了一个接口列表索引及快速定位锚点,所以就顺便稍微整理了一下这个文档,放到这里共享。

    作为一个开发人员,特别是要和手机客户端进行接口对接的开发人员,这么一个接口文档还是能起很大作用的。至少是一个他们可随时查阅的资料文档。

    也没有什么好多说的,实际就是自己简单写的一个html页面。看起来有那么个样子,比较简洁。下载地址:见本文关联的资源文件。截个效果图如下:

本文内容由网友自发贡献,转载请注明出处:https://www.wpsshop.cn/w/Monodyee/article/detail/489690
推荐阅读
相关标签
  

闽ICP备14008679号