首页 » 博文 » Code » 正文

世上最佳离线markdown编辑工具(gitbook和gitbook editor)

最近要写一下整个项目的说明文档(给内部人员使用的),刚开始选择的gitbook,后来涉及到一些机密的信息,没法写在公开的gitbook上,但是gitbook的主动生成带导航的html网站实在让人爱不释手。于是想自己搭建本地的gitbook,配合gitbook editor工具编写makedown文档,自己手动来生成html站点。还是非常不错的!

安装NVM和Nodejs

安装nodejs之前需要使用先安装nvm。nvm的项目地址为:https://github.com/creationix/nvm,README.makedown里已经有详细的安装说明了。这里简单介绍一下,记录下哀差闷遇到的错误。

1.打开终端, 运行  curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.31.4/install.sh | bash 

2.如果顺利的话,可以直接安装成功,提示类似于下面的信息:

=> Close and reopen your terminal to start using nvm or run the following to use it now:

export NVM_DIR="/var/root/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"  # This loads nvmsh-3.2#

3.将提示的信息中 后两行的内容拷贝一下:

export NVM_DIR="/var/root/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"  # This loads nvmsh-3.2#

4.回一下车,粘贴上面的内容执行(其实就是在添加环境变量),在输入nvm看看是否有相关信息出来,是则成功。

注意:如果遇到报错./install.sh: line 293: /nvm.sh: No such file or directory  可以忽略

5.安装nodejs,执行下面命令

#安装0.12.12版本的nodejs
sh-3.2# nvm install 0.12.12

如果没有这个版本,可以执行nvm ls-remote 看看有哪些版本。

安装gitbook

安装好nodejs后,就可以使用npm安装gitbook了,命令如下:

sh-3.2# npm install gitbook-cli 
-g/var/root/.nvm/versions/node/v0.12.12/bin/gitbook -> /var/root/.nvm/versions/node/v0.12.12/lib/node_modules/gitbook-cli/bin/gitbook.js
gitbook-cli@2.3.0 /var/root/.nvm/versions/node/v0.12.12/lib/node_modules/gitbook-cli
├── bash-color@0.0.4
├── q@1.4.1
├── semver@5.1.0
├── lodash@4.5.1
├── commander@2.9.0 (graceful-readlink@1.0.1)
├── tmp@0.0.28 (os-tmpdir@1.0.1)
├── optimist@0.6.1 (wordwrap@0.0.3, minimist@0.0.10)
├── npm@3.7.5
├── user-home@2.0.0 (os-homedir@1.0.1)
├── fs-extra@0.26.5 (path-is-absolute@1.0.0, klaw@1.3.0, jsonfile@2.3.1, graceful-fs@4.1.6, rimraf@2.5.4)
└── npmi@1.0.1 (semver@4.3.6, npm@2.15.10)

显示类似如上的信息,说明安装成功了。

Gitbook Editor

下载gitbook editor:https://www.gitbook.com/editor/

新建一本书:

 

QQ20160822-9

QQ20160822-8

cd到gitbook项目的目录,在osx下路径为:/Users/icharm/GitBook/Library/Import/duan_xin_xi_tong

然后分别执行:

 gitbook init   gitbook build 

就可以将makedown文件转化为带导航的html站点。

注意:如果在gitbook editor中安装第三方插件(比如主题啥的),build的时候会提示:

Error: Couldn’t locate plugins “page-treeview, theme-rangle-io”, Run ‘gitbook install’ to install plugins from registry.

参考

http://www.cnblogs.com/greenteaone/p/5065981.html

http://toolchain.gitbook.com/setup.html

发表评论