如何让 markdown 生成带目录的 html 文件 ?

想要让 markdown 文件生成下面这种带侧边栏目录的 html 文件,

只需要1分钟就能搞定.

npm install -g i5ting_toc

举个栗子:

你的 sample.md 文件放在桌面上

cd /Users/dora/Desktop/

i5ting_toc -f sample.md -o

然后,

就没有然后了.....

是不是超级简单!!!!!

此时你的桌面上就会出现一个 preview 的文件夹

点开看, 就是你想要的.

3个步骤

1、task ‘generate’

把README.md编译成html，并带有左侧目录功能。

这里使用tocmd命令（tocmd 是一个ruby gem，用于把markdown文件生成带有toc目录的html文档。）

tocmd_conf -f README.md

如果你本机没有安装的话，可以根据https://github.com/i5ting/tocmd.gem里的文档里安装方法

gem intall tocmd

前提是你一定要ruby2.0以上的环境哦。

2、task ‘rename’

这步主要是，上一步生成的文件是README.md，而静态网站使用的是index.html，所以需要重命名。

这里简单的把./preview/README.html文件复制为./preview/index.html

cp ./preview/README.html ./preview/index.html

3、task ‘deploy’

把./preview/**/*目录的内容推送到git仓库的gh-pages分支上。

这里主要使用gulp-gh-pages插件，它是会把指定目录的内容推送到git仓库的gh-pages分支上。

利用git pages静态http server的特性可快速建立网站。

var gp_deploy = require('gulp-gh-pages')

var options = {}

gulp.task('deploy', function () {

return gulp.src('./preview/**/*')

.pipe(gp_deploy(options))

})

---