首页   注册   登录
 star7th 最近的时间轴更新

star7th

  •   前端、PHP、node.js和Linux
    V2EX 第 148974 号会员,加入于 2015-11-27 23:25:32 +08:00
    今日活跃度排名 13431
    前端、PHP、node.js和Linux
    如何利用 showdoc 自动生成 API 文档
    程序员  •  star7th  •  111 天前  •  最后回复来自 star7th
    35
    如何利用 showdoc 自动生成数据字典
    程序员  •  star7th  •  232 天前  •  最后回复来自 star7th
    2
    开源的在线 API 文档、技术文档工具 ShowDoc
    程序员  •  star7th  •  2016-09-12 11:59:44 AM  •  最后回复来自 ixinshang
    21
    开源的任务队列服务 HTQ
    程序员  •  star7th  •  2016-09-07 15:52:46 PM  •  最后回复来自 star7th
    14
    ShowDoc:一个非常适合 IT 团队或个人的在线文档分享工具
    API  •  star7th  •  2015-12-16 16:15:52 PM  •  最后回复来自 SpicyCat
    1
    star7th 最近回复了
    三年前我也在写 hybrid app,也是自己写服务器。其实何止,包含 web 端,微信公众号端都是我写。其动力不来源于技术,与技术无关,与探索欲折腾欲无关,只是因为当时有不少人用我的产品,我想做得更好而已。
    4 天前
    回复了 jdhao 创建的主题 程序员 你是用什么工具写格式丰富的文档的?
    ### ShowDoc 是什么

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

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

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

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

    ### 它可以用来做什么

    - API 文档( [查看 Demo]( http://www.showdoc.cc/2))

    随着移动互联网的发展,BaaS (后端即服务)越来越流行。服务端提供 API,APP 端或者网页前端便可方便调用数据。用 ShowDoc 可以非常方便快速地编写出美观的 API 文档,同时还将支持从代码文件中自动生成 API 文档

    - 数据字典( [查看 Demo]( http://www.showdoc.cc/1))

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

    - 说明文档([查看 Demo]( http://www.showdoc.cc/3) )

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

    ### 它都有些什么功能


    - ** 分享与导出 **

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

    - ** 权限管理 **
    - 公开项目与私密项目

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

    - 项目转让

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

    - 项目成员

    你可以很方便地为 ShowDoc 的项目添加、删除项目成员。项目成员可以对项目进行编辑,但不可转让或删除项目(只有项目创建者才有权限)
    - 团队管理
    你可以自行添加多个团队,为团队分配不同的项目,同时设置团队里每个人的权限。

    - ** 编辑功能 **
    - markdown 编辑

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

    - 模板插入

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

    - 历史版本

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


    ### 安装到自己的服务器


    - 安装手册:[https://www.showdoc.cc/help?page_id=13732]( https://www.showdoc.cc/help?page_id=13732)
    - 若觉得 showdoc 好用,不妨点个 star。良好的关注度和参与度有助于开源项目的长远发展。开源地址: https://github.com/star7th/showdoc



    ### 使用在线的 ShowDoc

    - 如果你没有自己的服务器,但又想使用 ShowDoc 作为分档分享工具,你可以使用在线的 ShowDoc [http://www.showdoc.cc]( http://www.showdoc.cc/home/user/login)

    - http://www.showdoc.cc 作为在线服务会长期维护,请放心托管你的文档数据。使用在线服务时请记住 showdoc 唯一官方网址 https://www.showdoc.cc
    8 天前
    回复了 symb0l 创建的主题 Linux 办公云盘
    用 nextcloud 吧,偏向文件管理。
    刚好总结出了一个脚本,给你看下 http://blog.star7th.com/2018/11/2329.html
    总之希望你做好定位,专注降低入门门槛。以此为方向。也许真的可以适度帮助某些菜鸟入行
    坚持中文编程的人以为自己是爱国 /坚持理想 /降低编程门槛 ,但都是菜鸟的表现。
    衡量一件事值得还是不值得,关键看它能创造多大价值。中文编程的唯一价值就是对某些英语水平差的差生(大学以下)入门编程较为友好。中国不会编程的人很多,也许可以从这方面打开一下市场需求。
    但在专业领域,就别来民科式的搞笑了。只有菜鸟才停留在纠结那么几个英文单词的水平上。懂编程的人早就远远超过了语法层面,更多从编程思路 /思想 /架构方面思考。何况你说的中文编程不过是翻译而已。为了躲避几个英文单词,硬生生记住多一套语法,值得么。学中文编程的人都是刚入门的人,而如果真的入门了编程的人,会发现编程世界的浩瀚,放弃中文编程,寻找更广大的世界去了
    60 天前
    回复了 Jaeger 创建的主题 程序员 你们的开源项目的官网都是用什么搭建的?
    我用我自己写的,你可以试试 https://www.showdoc.cc/
    61 天前
    回复了 nellace 创建的主题 程序员 近十年科技是不是停滞了
    当一个村庄都是平房的时候,如果开始盖起几十座的大厦,就很容易被人拍手称赞这是颠覆性发展。
    当大厦已经开始普遍的时候,它已经成为了一个城市。城市推到重来的成本,明显比颠覆村庄的成本高多了。所以进入现代化后,更多是完善已有的东西,而不是总是把已有的东西颠覆重来。
    所以,我觉得你对科技发展的定义是狭隘的,并不是只有新型事物颠覆了旧事物才叫发展。能通过科技的手段让生活变得更好,这就是发展。
    你没有发展这十年来,移动支付对现实生活的改变吗?大城市基本都普及了手机支付。而从手机支付出发,线下消费如外卖 /共享单车也应声而起,并且接下来还将有大量的线下消费场景可以挖掘。
    现在云计算 /大数据技术都在蓬勃发展,大大地改变了很多企业的运维方式,节省了很多运作成本,提高了效率。十年前,还没有多少企业敢大量使用公有云(至少国内是),或者利用开源技术搭建私有大数据云?而现在,如果有经济投入的必要性,基本没有企业抗拒云了(公有云或者私有云)。
    我觉得,互联网的往后十年或者二十年的发展更多发生在企业上,用互联网技术改善传统行业,提高社会整体效率。这个过程中,不仅经济变好,也可能会爆发出很多创新点。未来有什么可能性,很难预知的。
    而且,把时间范围拉大,这几十年来,技术一直都在发展,偶尔快偶尔慢,从来没停滞
    很早前写的一个简单开源队列服务 https://github.com/star7th/htq
    关于   ·   FAQ   ·   API   ·   我们的愿景   ·   广告投放   ·   感谢   ·   实用小工具   ·   1567 人在线   最高记录 4019   ·  
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.1 · 18ms · UTC 16:49 · PVG 00:49 · LAX 08:49 · JFK 11:49
    ♥ Do have faith in what you're doing.
    沪ICP备16043287号-1