构建开发文档API管理系统(GitBook)

知识笔记

本文使用GitBook配合项目Markdown自动生成文档并部署

安装GitBook

npm install -g gitbook

npm install -g gitbook-cli

开发编辑Markdown API文档

#项目目录下初始化book目录
gitbook init book

#开发编辑Markdown文件
#README.md
    #Introduction
    ...

#生成html文档
#执行以下命令会在book目录生成一个_book的目录,里面就是生成的html文档了
gitbook build book

GitBook目录

SUMMARY.md -- 文档左边栏导航
README.md -- 文档主页,用于介绍文档内容描述

未完待续。。。

你可能感兴趣的:(构建开发文档API管理系统(GitBook))