gitbook的搭建及word转markdown_word转readme

gitbook配置搭建文档

GitBook 是一个基于 Node.js 的命令行工具，首先需要下载安装nodejs

1、安装 Node.js

• 获取Node.js 安装包

  Node.js
  安装包及源码下载地址为https://nodejs.org/en/download/，根据系统选择你需要的
  Node.js 安装包

• ** Linux 上安装 Node.js **

	wget https://nodejs.org/dist/v12.18.1/node-v12.18.1-linux-x64.tar.xz
	tar xf node-v12.18.1-linux-x64.tar.xz
	cd node-v12.18.1-linux-x64
	vim /etc/profile，在最下面添加 export PATH=\$PATH: 后面跟上 node 下 bin目录的路径
	export PATH=\$PATH:/root/node-v12.18.1-linux-x64/bin
	source /etc/profile //立即生效
	node -v  //查看是否安装成功
	v10.15.3 //表示安装成功
1
2
3
4
5
6
7
8

2、安装 GitBook

  $ npm install gitbook-cli -g
  $ gitbook -V //查看是否安装成功
  表示安装成功:
  CLI version: 2.3.2 
  GitBook version: 3.2.3
1
2
3
4
5

进入你要写书的目录，输入如下命令。

  $ gitbook init
  warn: no summary file in this book
  info: create README.md
  info: create SUMMARY.md
  info: initialization is finished
1
2
3
4
5

可以看到会创建 README.md 和 SUMMARY.md
这两个文件，README.md是说明文档，SUMMARY.md
是书的章节目录，其默认内容如下所示：

  # Summary
  * [Introduction](README.md)
1
2

接下来，输入下方命令：

  $ gitbook serve
1

然后在浏览器地址栏中输入 http://localhost:4000 便可预览书籍。

效果如下所示：

运行该命令后会在书籍的文件夹中生成一个 _book 文件夹, 里面的内容即为生成的 html
文件，我们可以使用下面命令来生成网页而不开启服务器：

   gitbook build
1

• 配置介绍：

• **book.json：**主要用来存放配置信息

参数简单介绍：

title:本书标题

author:本书作者

description:本书描述

language:本书语言，中文设置 "zh-hans" 即可

gitbook:指定使用的 GitBook 版本

styles:自定义页面样式

structure:指定 Readme、Summary、Glossary 和 Languages 对应的文件名

links:在左侧导航栏添加链接信息

plugins:配置使用的插件

pluginsConfig:配置插件的属性
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

• SUMMARY.md：存放目录信息,自行修改即可

 gitbook install ./
1

3、word文档转markdown

writage 插件，下载地址http://www.writage.com/#download

下载安装完成后，重新打开word，保存原word文档为markdown类型即可