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地址

生成例子

相關文章
相關標籤/搜索