Tagged

Atom

Atom是由GitHub开发的自由及开放源代码的文字与代码编辑器,支持OS X、Windows和Linux操作系统,支持Node.js所写的插件,并内置由Github提供的Git版本控制系统

使用 API Blueprint 来编写 RESTful API 文档
API Blueprint

使用 API Blueprint 来编写 RESTful API 文档

可能在很多地方,编写文档或许是非常敷衍或潦草的事情,一个可能连排版都没有的 Word 文档可能就充当了文档的重要地位,但是这对于开发协作和后期的未知问题,仅仅只是时间的问题。在开发 RESTful API 中,随着时间的增长,API 的数量越来越多,查阅维护整理也就变得更加需要,文档需求的地位就越来越高。而编写 RESTful API 文档的方式有很多,例如:RAML、Swagger、apiDoc... 而我选择的是 API Blueprint,为啥呢?因为是用 Markdown 来进行编写,而且能够利用一些工具通过语法渲染成文档网页,何乐而不为呢? I. 语法 之前我们讲了,API Blueprint 虽然是以 Markdown 为基础语法,但后缀名规范保存为 .apib 而不是 .md ,想入坑也是要记住一些 API Blueprint 规范的指定语法的,语法方面我认为只需要讲比较重要的要点而不需要详细来讲,

Atom 在国内无法安装 Package 的解决方案
Atom

Atom 在国内无法安装 Package 的解决方案

由于被墙的原因,在国内使用 Atom 的 Package(包)面板来安装 Package 基本都无法正常安装,有些时候 VPN 也不好使,那么怎么才能完美的安装 Package 呢?我们用 npm[1] 来解决 安装 npm 并且替换内置源为国内淘宝源 npm 一般在已经安装了 Node.js 的运行环境中就已默认安装,此篇便不过多介绍 Node.js 了,Node.js 是一个基于 Chrome's V8 JavaScript引擎 的 JavaScript 运行环境 安装 npm 可以访问 Node.js 的 官网 下载安装,安装后打开 Terminal,