写在前面
Md2site是基于Omi的一款Markdown转网站工具,使用简单,生成的文件轻巧,功能强大。
当我们想把一堆markdown文档转成网站时,你可能有许多选择,倘若选择 md2site ,你一定会爱上她。
$ npm install md2site -g
安装完之后就可以使用md2site 命令了。
$ md2site init your_project_name
比如我创建一个omi的文档:
这个时间比较长,因为还会安装相关的npm依赖包。安装成功可以看到:
$ cd your_project_name
转到对应的项目目录。
找到your_project_name目录下的docs目录:
在里面写你的markdown文档。在config.js中配置对应的目录树:
[ [ ] } ][ [ ] } ] config;
写的过程中可以通过下面的命令可以进行网站预览
$ npm run dev
也可发布部署:
$ npm run dist
一款漂亮的多语言响应式无刷新的精明文档网站就这么搞定了!简单吧~~
Markdown语法扩展如果你想让代码块中的某些行高亮,比如这个样子:
你可以使用这种语法来标记需要高亮的行:
上面代表:1到3行以及26行高亮。
Github