我喜欢在我的项目中同时使用JSON和Markdown。每个npm包都需要一个package.json文件,该文件先让是用JSON格式编写的。另外,好的项目需要配套好的文档。我喜欢使用Markdown写文档。
但我真的不写Markdown文件,我写的是文档,但他们存储在代码中(JSDoc注释)。我使用Blah
自动生成Markdown文档的,然而有时候这些文档模版不够。
这就是我创建json2md的原因,它是JSON和Markdown语言之间的桥梁,此包与我的Blah模版集成,我可以使用JSON 在我的package.json (或其他JSON文件)中编写自定义内容,来定制输入在最终文档结果。
如何使用 使用npm i json2md
在本地下载并安装json2md
软件包。然后你可以在Node.js应用程序中,甚至客户端(浏览器)中使用它。
例如,要创建Markdown 图片 标签,你需要执行一下操作:
var json2md = require("json2md");
var myImg = json2md({
img: {
source: "http://example.com/image.png"
, ti