Skip to content

将makdown编译成html+js+css的类vue文档格式(拥有导航和样式)的命令行工具

License

Notifications You must be signed in to change notification settings

xuzhongpeng/mdtodoc

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

title
markdown转换成标准文档工具

介绍

本工具可以对markdown格式文档转换成类似element、vue形式的文档格式,基于marked工具,会生成成默认的文档格式,例如我的博客一篇文章,在博客显示是这样的

博客

生成后:

生成后的图片

文件生成后,大家可以修改style中的css样式进行自定义。

使用方法

  • node <<8.9.3
  • npm <<5.5.1

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

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

npm install mdtodoc -g

新建一个目录,把自己写的markdown文件拷贝到该目录,例如 生成后的图片

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

mdtodoc g change 文件名

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

mdtodoc g change index.md

生成目录结构如下:

生成后的图片

注意

如果要给文章写标题,可在文章顶部设置

title:markdown转换成标准文档工具

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

---
title:markdown转换成标准文档工具
---

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

github地址

生成例子

About

将makdown编译成html+js+css的类vue文档格式(拥有导航和样式)的命令行工具

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published