Spec Markdown 是一个基于markdown 的文档编写工具,安装简单,可以让我们编写出专业的文档 参考项目 https://github.com/rongfengliang/spec-md-demo 安装 全局 npm install -g spec-md 本地项目依赖 npm install --save-dev spec-md 项目使用 因为个人原因,比较喜欢使用yarn,所以项目基于yarn 初始化 初始化 yarn init -y 配置构建&&依赖 yarn add s…

最近公司开发项目需要前后端分离,这样话就设计到后端接口设计.复杂功能需要提供各种各样的接口供前端调用,因此编写API文档非常有必要了 网上查了很多资料,发现基于Markdown编写文档是一种比较流行而且成熟的方案了,话不多说,我也搞一搞试试. 电脑操作系统:deepin深度 Linux64位,比较难用的一个系统,但是公司强制使用,没办法 1.这里我用到了gitbook,GitBook 是一个基于 Node.js 的命令行工具,支持 Markdown 和 AsciiDoc 两种语法格式,可以输出…

背景介绍 作为一个技术人员,基本都需要编写技术相关文档,而且大部分技术人员都应该掌握 markdown 这个技能,使用 markdown 来编写并生成 PDF 文档将会是一个不错的体验,以下就介绍下如何使用 VS Code + Markdown 来编写 PDF 文档 效果演示 环境准备 [必须]安装 Visual Studio Code [必须]安装 Extension - Markdown PDF,主要用于生成 PDF [可选]安装 Extension - markdownlint,用于 ma…

接口名称 1) 请求地址 https://apis.cnblogs.com/user/info?a=xx&b=xx 2) 调用方式:HTTP GET 3) 接口描述: 接口描述详情 4) 请求参数: GET参数: 字段名称 字段说明 类型 必填 备注 a string Y - b string Y - 5) 请求返回结果: { "errNum": 10001, "errMsg": "Param error" } 6) 请求返回结果参数说明…

1. 为什么抛弃MarkdownPad 2 ? MarkdownPad坊间号称 Windows 环境下最好用的markdown编辑器-EXO me??? 博主入MarkdownPad 2 坑就是因为这个坊间口碑,但是使用起来并不舒心-原因如下: 笨重,每次打开md文档都需要等待软件启动 无法预览效果,需要安装额外的软件Awesomium 打开文档,预览显示一片空白也是常事 2. Notepad++ 免费 轻量 插件众多 台湾同胞开发 支持众多语言风格的展示(可以集成编辑各类文档) 3. 搭建编写…

NVelocity是什么velocity英音:[vi'lɔsiti]美音:[və'lɑsətɪ]近在做一个项目,客户要求有网站模板功能,能够自主编辑网站的风格,因为这个系统是为政府部门做子站系统,举个例如:每个街道办拥有一个站点,而且可以设置他们的风格.ASP.Net下的Skin技术可能能够实现这个功能的,不过我个人觉得Asp.net的Skin技术相对于我的项目来过于复杂了,我需要一个能像PHP下Smarty模板技术的就足够了.在网络上搜索了一阵,最后找到了NVelocity.NVelocity…

如果你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",加入这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的好处是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构可以提供追溯其他工作产品的上下文. 有文档的架构可以传达可供选择的架构解决方案. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构可以提醒架构师在其所作的某些决定背后的…

假设你对项目管理.系统架构有兴趣,请加微信订阅号"softjg",增加这个PM.架构师的大家庭 问:为什么要编写软件架构文档,它的优点是什么? 答: 有文档的架构有助于不同利益相关者之间进行有效的沟通. 有文档的架构能够提供追溯其它工作产品的上下文. 有文档的架构能够传达可供选择的架构解决方式. 有文档的架构有助于从一个现有架构转换到一个新架构计划的计划编制. 有文档的架构通常能通过识别组成架构的元素及它们之间的依赖性来帮助编制计划. 有文档的架构能够提醒架构师在其所作的某些决定背后的…

上回说到,用Impress.js代替PPT来做项目展示.这回换Markdown来做接口文档好了.(不敢说代替Word,只能说个人感觉更为方便)当然,还要辅之以Git,来方便版本管理. Markdown基本语法也没啥好说的,随便百度一下几分钟看懂基本的,20%的知识完成80%的任务嘛,够了. 关键在于,我有些特殊需求,以方便将Markdown作为接口文档查看.什么需求呢? 目录.这是重中之重.没有方便的TOC的话,文档长了,查看起来真是费劲.我理想中的目录是这样的: 根据H1(# ).H2(## …

使用 Laravel-Swagger 编写接口文档 Table of Contents Swagger 文档管理 官方网站:https://swagger.io/ 快速编写你的 RESTFUL API 接口文档工具,通过注释定义接口和模型,可以和代码文件放置一起,也可以单独文件存放. 优势 通过代码注解定义文档,更容易保持代码文档的一致性 模型复用,减少文档冗余,带来更可靠的文档 提供客户端访问接口,可以直接调试接口,不需要第三方工具进行调用测试接口 支持权限认证,等功能 Laravel Swa…