为啥要用docsify? 神器Docsify让你的文档变得美观,配合typora,从此爱上看文档,各种优点:小巧.快速.美观.方便.快捷.上手快,可以浏览如下优秀案例 ve-charts pyecharts pyecharts-gallery 处于萌芽阶段的 Java 核心知识库 更多案例请看:Awesome Docsify 安装 1.首先安装npm: sudo apt install npm 如果报错,则执行如下命令安装相关依赖 sudo apt-get install nodejs-dev…
本文来自网易云社区 作者:李哲 接口文档管理一直是一个让人头疼的问题,伴随着各种接口文档管理平台涌现,如阿里开源的rap,ShowDoc,sosoapi,等等(网上能找到很多这种管理平台,包括我们自己做的idoc).这些平台都是一个共同特点,创建文档,编辑,保存文档,一些功能强大的还有mock,统计接口信息等功能,所以这些平台更像一个接口文档的存储管理系统,可以方便人们查看.编辑文档.然而接口一般都是经常变化(添加.删除参数),这就需要接口编写者及时更新文档,否则文档将失去意义,但是频繁去更新文…
Eolinker API 接口文档神器 群里小伙伴推荐的,还没有去研究,先记下来. API文档管理.自动化测试.开发协作利器 正在为数万企业管理超过100万APIs,提高开发效率以及规范开发流程…
本文来自网易云社区 作者:李哲 二.Swagger-springmvc原理解析 上面介绍了如何将springmvc和springboot与swagger结合,通过简单配置生成接口文档,以及介绍了swagger提供的一些注解.下面将介绍swagger是如何做到与springmvc结合,自动生成接口文档. 项目添加完成maven依赖后会加入swagger的依赖包,其中包括swagger- springmvc,swagger-annotations,swagger-models几个依赖包.如下图所示:…
接口开发,最麻烦的就是写文档了,曾经我也因为写接口文档苦不堪言:自从使用了apiui接口文档神器,工作效率和文档清晰得到了不止一个档次的提升. 下面介绍一下这个神器的使用: 把文件下载下来,放在网站根目录: 链接:https://pan.baidu.com/s/1DaT_rUANaSoHVhy8BjtQRw 密码:atgu 更改index.html文件的三个参数: 然后打开api.json文件,添加对应的接口模块: { "apiVersion":"0.2", &qu…
HTML&CSS基础-文档声明 作者:尹正杰 版权声明:原创作品,谢绝转载!否则将追究法律责任. 一.HTML的发展 1993年6月: HTML第一个版本 1995年11月: HTML2.0 1997年1月: HTML3.2(W3C推荐) 1999年12月: HTML4.01(W3C推荐) 2000年底: XHTML1.0(W3C推荐),该版本是吸收了XML的一些标准,想让用户过渡到XML相关语法的特性,可惜官网并没有实现自己的期望,于是在2014年H5发布. 2014年10月: HTML5(W…
转载自:http://blog.163.com/hui_san/blog/static/5710286720104191100389/ 前言 Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗? 1)// 注释一行   2)/* ...... */ 注释若干行 3)/** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /**   * .........   * .........   */ 这第三种注释有什么用?javado…
此教程基于本地己安装好 PYTHON 并配置过全局变量:一定具备相应的基础再操作: 上传图片以免产生误导,以下为文字描述,按下列操作即可: 下载 get-pip.py脚本; python get-pip.py -(很多教程,执行这个文件,就直接使用PIP .其实还需要配置PIP的全局变量:如果知道全局PYTHON安装在哪里或是不知道,参考寻找目录为:C:\Users\Administrator\AppData\Local\Programs\Python\Python36-32\Scripts)…
前提 下面的简介摘抄自docsify的官网 https://docsify.js.org 中的简介 docsify是一个神奇的文档网站生成器.他可以快速帮你生成文档网站.不同于GitBook.Hexo的地方是它不会生成静态的.html文件,所有转换工作都是在运行时.如果你想要开始使用他,只需要创建一个index.html就可以开始编写文档并直接部署在GitHub Pages(码云Pages.阿某云OSS或者鹅云COS等等).它的主要特性如下: 无需构建,写完文档直接发布(运行时markdown文…
http://pandoc.org/ 因为工作需要,将一批markdown的文档转换成word文档,找来找去,这个pandoc真是神器 啊,推荐给大家 If you need to convert files from one markup format into another, pandoc is your swiss-army knife. Pandoc can convert documents in (several dialects of) Markdown, reStructure…