markdown转html
今天临时要写接口文档,然后发现部门给的文档是markdown文件的,而接口文档是要html格式的,因此想直接把markdown转为html
这里我使用的是marked
首先初始化一个node项目 npm init
然后安装marked npm install marked --save
先引入fs和marked
const fs = require('fs');
const marked = require('marked');
接着在创建一个模板文件,命名为template.html(这里面创建出页面的主体,以及需要引入的css样式),@markdown即为之后转换成功要替换的位置
<!DOCTYPE html> <html lang="zh-CN"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no"> <meta name="author" content="Yaofeng"> <title>文档</title> <link rel="stylesheet" href="./markdown.min.css"> <style> </style> </head> <body> @markdown </body> <script></script> </html>
接着完成入口文件
const fs = require('fs'); const marked = require('marked'); fs.readFile('./template.html', 'utf8', (err, template)=>{ if(err){ throw err }else{ fs.readFile('./香港退款订单接口.md', 'utf8', (err,markContent)=>{ if(err){ throw err }else{ // 转化好的html字符串 let htmlStr = marked(markContent.toString()) // 将html模板文件中的 '@markdown' 替换为html字符串 template = template.replace('@markdown', htmlStr) // 将新生成的字符串template重新写入到文件中 fs.writeFile('./香港退款订单接口.html', template, err=>{ if(err){ throw err }else{ console.log("success") } }) } }) } })
至此结束
样式下载:https://github.com/zhangjikai/markdown-css