基于 Markdown 编写接口文档-优快云博客

本文介绍了如何在deepin Linux系统上使用Markdown和GitBook编写和发布接口文档。首先，介绍了安装GitBook的过程，包括解决命令执行问题。接着，提到了使用Typora作为Markdown编辑器，并详细说明了Typora的安装步骤。最后，展示了使用Typora编辑SUMMARY.md文件以构建书籍目录的流程。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

最近公司开发项目需要前后端分离，这样话就设计到后端接口设计。复杂功能需要提供各种各样的接口供前端调用，因此编写API文档非常有必要了

网上查了很多资料，发现基于Markdown编写文档是一种比较流行而且成熟的方案了，话不多说，我也搞一搞试试。

电脑操作系统：deepin深度 Linux64位，比较难用的一个系统，但是公司强制使用，没办法

1、这里我用到了gitbook，GitBook 是一个基于 Node.js 的命令行工具，支持 Markdown 和 AsciiDoc 两种语法格式，可以输出 HTML、PDF、eBook 等格式的电子书。关于更多介绍可以参考：http://www.chengweiyang.cn/gitbook/introduction/README.html 。安装gitbook可以直接使用命令： npm install gitbook-cli -g 来进行安装。当然前提是安装了nodejs ，因为我们前端项目用的vue，加载依赖也需要nodejs，所以我已经提前装好了直接使用。安装nodejs可以参考：https://www.cnblogs.com/liuqi/p/6483317.html（非常赞）

执行完上面命令以后，可能需要设置软连 nodejs中的gitbook ：ln -s /opt/nodejs/bin/gitbook /usr/local/bin/gitbook ，然后执行gitbook -V 来查看版本，首次会自动安装gitbook。

2、安装好gitbook以后，你就可以新建一个目录，mybook ࿰