markdown转换成标准文档工具


date: 2018-08-25 16:03:40css

tags: [node,markdown,npm]html


github地址vue

生成例子node

介绍

本工具能够对markdown格式文档转换成相似element、vue形式的文档格式,基于marked工具,会生成成默认的文档格式,例如个人博客一篇文章,在博客显示是这样的webpack

博客
eg2

生成后:git

生成后的图片
eg1

文件生成后,你们能够修改style中的css样式进行自定义。github

使用方法

  • node <<8.9.3
  • npm <<5.5.1

node环境和npm环境如上,低于如上环境我没有测试,理论上也能够运行web

打开命令行工具,全局安装mdtodocshell

npm install mdtodoc -g
复制代码

新建一个目录,把本身写的markdown文件拷贝到该目录,例如 npm

生成后的图片
eg3

命令行进入到该目录, 执行

mdtodoc g change 文件名
复制代码

如文件名为上图中的index.md

mdtodoc g change index.md
复制代码

生成目录结构以下:

生成后的图片
eg4

注意

若是要给文章写标题,可在文章顶部设置

title:markdown转换成标准文档工具
复制代码

便可转化成功,不可添加其它符号,例如

---
title:markdown转换成标准文档工具
---
复制代码

如此会致使页面生成混乱,后期会进行修改

github地址

生成例子

相关文章
相关标签/搜索