showDoc 文档管理系统支持markdown

lingdududu 发布于2019-06-27 16:29 / 605人阅读

摘要：用可以非常方便快速地编写出美观的文档。同时也可以将项目导出成文件，以便离线浏览。权限管理公开项目与私密项目上的项目有公开项目和私密项目两种。项目成员你可以很方便地为的项目添加删除项目成员。

下载地址：https://github.com/star7th/sh...

ShowDoc是什么

每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！

程序员都很希望别人能写技术文档，而自己却很不希望要写文档。因为写文档需要花大量的时间去处理格式排版，想着新建的word文档放在哪个目录等各种非技术细节。

word文档零零散散地放在团队不同人那里，需要文档的人基本靠吼，吼一声然后上qq或者邮箱接收对方丢过来的文档。这种沟通方式当然可以，只是效率不高。

ShowDoc就是一个非常适合IT团队的在线文档分享工具，它可以加快团队之间沟通的效率。

它可以用来做什么

API文档 http://www.showdoc.cc/demo?page_id=7

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

数据字典 http://www.showdoc.cc/data-dictionary?page_id=13

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

说明文档 http://www.showdoc.cc/help?page_id=14

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

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

权限管理

    公开项目与私密项目

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

    项目转让

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

    项目成员

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

编辑功能

    markdown编辑

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

    模板插入

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

    历史版本

    ShowDoc为页面提供历史版本功能，你可以方便地把页面恢复到之前的版本。
    
    部署到自己的服务器

ShowDoc部署手册

请参考：http://blog.star7th.com/2016/05/2007.html

使用在线的ShowDoc

如果你没有自己的服务器，但又想使用ShowDoc作为分档分享工具，你可以使用在线的ShowDoc http://www.showdoc.cc

http://www.showdoc.cc 作为在线服务会长期维护，请放心托管你的文档数据。使用在线服务时请记住showdoc唯一官方网址showdoc.cc

云服务器 GPU云服务器支持markdown的博客 showdoc 文档管理系统文档管理

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/22955.html

在线文档分享工具ShowDoc

摘要：就是一个非常适合团队的在线文档分享工具，它可以加快团队之间沟通的效率。部署到自己的服务器部署手册请参考使用在线的如果你没有自己的服务器，但又想使用作为分档分享工具，你可以使用在线的版权遵循开源协议发布，并提供免费使用。 ShowDoc是什么每当接手一个他人开发好的模块或者项目，看着那些没有写注释的代码，我们都无比抓狂。文档呢？！文档呢？！Show me the doc ！！程序...

JeOam 2019-06-27 11:46 评论0 收藏0
PHP实现markdown文档管理工具

摘要：工作后一直在从事开发从以前的大包大揽到现在的退居服务端写接口当中接触过几个的接口文档管理工具或系统简单描述下功能全面而且简洁有用户权限管理功能支持支持导出有多种文档模板目录支持两级折叠功能强大权限管理邮件提醒全文搜索插件管理等重收费的一个文工作后一直在从事PHP开发, 从以前的大包大揽到现在的退居服务端写接口, 当中接触过几个的接口文档管理工具或系统, 简单描述下: showdoc...

wpw 2019-06-28 18:22 评论0 收藏0
Wizard 开源文档管理系统1.0发布啦

摘要：总结如果你在为公司寻找一款开源免费的开发文档文档管理工具，不妨考虑一下项目，一定不会让你失望的。 Wizard 是一款开源文档管理系统，项目地址为 https://github.com/mylxsw/wizard。这个项目是我在2017年就开始开发的，起初只是想做一款能够在公司内部把Swagger文档管理起来的工具，但在这近两年的时间里，一直断断续续的为其添加各种功能，现在终于下决...

cod7ce 2019-07-01 12:44 评论0 收藏0
如何利用showdoc自动生成数据字典

摘要：关于的详细介绍，可看好的数据字典文档能够清晰地反映出数据库的结构以及相关释义，方便技术人员查阅。自动执行的情况下，只会自动新增和修改文档，不会自动删除文档主要出于数据安全考虑。介绍 showdoc是一个非常适合IT团队的在线API文档、技术文档工具。你可以使用Showdoc来编写在线API文档、技术文档、数据字典、在线手册。关于showdoc的详细介绍，可看：https://www....

lookSomeone 2019-08-22 16:39 评论0 收藏0