ShowDoc 在线文档分享工具

开源网站开源项目 24-03-29 13:16:58

ShowDoc 是一个非常适合 IT 团队的在线文档分享工具,它可以加快团队之间沟通的效率。通过 showdoc,你可以方便地使用markdown语法来书写出美观的API文档、数据字典文档、技术文档、在线excel文档等等。如果不想编辑markdown文档,你还可以利用showdoc的自动化能力,从程序注释中自动生成API文档,或者从搭配的RunApi客户端(类似postman的api调试工具)中一边调试接口、一边自动生成文档。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc还支持多平台客户端,有win客户端、mac客户端、ios、android等,更方便跨平台使用。

目前超过100000+的互联网团队正在使用showdoc,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。

它可以用来做什么

API文档(查看Demo)

随着移动互联网的发展,BaaS(后端即服务)越来越流行。服务端提供API,APP端或者网页前端便可方便调用数据。用ShowDoc可以非常方便快速地编写出美观的API文档。

数据字典(查看Demo)

一份好的数据字典可以很方便地向别人说明你的数据库结构,如各个字段的释义等。

说明文档(查看Demo)

你完全可以使用showdoc来编写一些工具的说明书,也可以编写一些技术规范说明文档以供团队查阅。

它都有些什么功能

分享与导出

响应式网页设计,可将项目文档分享到电脑或移动设备查看。同时也可以将项目导出成word文件,以便离线浏览。

权限管理

公开项目与私密项目

ShowDoc上的项目有公开项目和私密项目两种。公开项目可供任何登录与非登录的用户访问,而私密项目则需要输入密码验证访问。密码由项目创建者设置。

项目转让

项目创建者可以自由地把项目转让给网站的其他用户。

项目成员

你可以很方便地为ShowDoc的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)

编辑功能

markdown编辑

ShowDoc采用markdown编辑器,无论是编辑还是阅读体验都极佳很棒。如果你不了解Markdown,请在搜索引擎搜索”认识与入门 Markdown”

模板插入

在ShowDoc的编辑页面,点击编辑器上方的按钮可方便地插入API接口模板和数据字典模板。插入模板后,剩下的就是改动数据了,省去了很多编辑的力气。

历史版本

ShowDoc为页面提供历史版本功能,你可以方便地把页面恢复到之前的版本。

[ShowDoc 在线文档分享工具]相关推荐
LAPACK 线性数学库

LAPACK 线性数学库

LAPACK,其名为Linear Algebra PACKage的缩写,是一以Fortran编程语言写就,用于数值计算的函式集。 LAPA……...

notty 虚拟终端

notty 是个类似 xterm,GNOME-vte,sh 和 rxvt 的终端模拟器。跟那些程序不一样的地方是,notty 不是为了……...

Imagine GUI 图片压缩工具

Imagine GUI 图片压缩工具

一个 GUI 图片压缩工具。 支持 PNG 和 JPEG 格式图片的压缩和转换,并支持转换到 WebP。 支持压缩参数调……...

Dream 缺陷跟踪系统

Dream 缺陷跟踪系统

Dream缺陷跟踪系统2.0是九五时代与梦赢科技共同推出的项目BUG快速解决方案,,是一款让项目BUG以最快的速……...

今日开源
  1. JUDO 面向企业使用的低代码平台

    JUDO 是一个面向企业使用的低代码平台。但与其他流行的低代码平台不同,JUDO 不是图形设计工具。它提供了一种基于文本的语言,称为 JSL(JUDO 规范语言)。JSL 的总体目标是培养明确且可读的应用程序描述。由于 JS……

    开源软件 2024-05-10

  2. Vcpkg VC++ 打包工具

    vcpkg 是微软 C++ 团队开发适用于Windows,Linux 和 MacOS 的 C ++库管理器。 vcpkg 自身也是使用 C++ 开发的 (而其他的 C++ 包管理大多并不是 C++ 开发的),并且 vcpkg 能够帮助用户在 Visual Studio 中更好地使……

    开源软件 2024-05-10

  3. Plop 低开销 Python 程序分析工具

    Plop 是一个对 Python 程序栈区取样的分析工具,可以随意的开启或者关闭,而对性能的影响很小。 安装: pipinstallplop 用法: 要对整个Python脚本进行概要分析,请运行: python-mplop.collectormyscript.py 分析……

    开源软件 2024-05-10

返回顶部小火箭