# 前端文档撰写 此文档由Gitbook撰写,以下内容介绍如何用Gitbook生成文档 > 官方文档:http://help.gitbook.com/ ## 一、Gitbook 安装 1. 安装nodejs:https://nodejs.org/ 2. 安装Git:http://git-scm.com/download/ (如果需要你的文档同步到Github上的话) 3. 命令行: ``` $ npm install gitbook-cli -g ``` > 注意,因为Mac下装的话需要管理员权限,所以要在前面加上sudo ## 二、Gitbook 命令 1. **gitbook init** 根据目录中的SUMMARY.md来生成对应的目录 > SUMMARY.md相当于文档整个的脉络,也就是目录,init命令会根据你在SUMMARY.md撰写的相关目录和文件名来直接创建文件 2. **gitbook build** 生成文档文件,生成目录是本目录下的_book > 根据文档文件生成对应的html最终文件 3. **gitbook serve** 生成文档文件,并启动服务 > 可以实时监控文档文件变化,并生成最新的文档文件,适合在撰写过程中观看文档变化 ## 三、Gitbook 撰写 语法是Markdown语法,可以直接看svn上的文档源文件学习,对我们来说是零难度的,是现在最流行的语法之一 http://www.jianshu.com/p/1e402922ee32/ > 文档的制作其实就是MarkDown文件转成HTML,Markdown是兼容Html,也就是在Markdown文件中写html代码也是没问题的,所以对我们前端来说是零难度,语法方面就参考上面的地址就行,或者直接通过svn上的源文件学习即可,几分钟就可以上手 ### 基本语法说明 请直接看本文档中其他的markdown文件并学习,零难度 ## 四、自定义样式 css文件在styles/website.css中,可以自行添加相关样式,其他自定义方法可以在官方文档中查看