object2md

0.0.1 • Public • Published

object2md

可以将任意的json定义文件转换为markdown文件

支持外部自定义模板转换,使用handlebars语法

支持整个目录下的json文件批量转换,为了方便和性能,目前仅支持一级目录下所有json文件

安装命令

npm install object2md -g

运行命令

object2md -help

使用方式: object2md [存放json定义的文件路径] [选项组合]

选项:
  -v, --version  显示版本号                      [字符串]
  -o, --ouput    生成的markdown文件路径           [字符串] [必需] [默认值: "md-dist"]
  -t, --type     handlebars模板文件,定义json对象转换到markdown的模板,可由外部指定(此时传入的是一个handlebars
                 模板文件路径,模板的上下文就是输入的json对象),内置widget类型模板,默认值widget
                                                [字符串] [必需] [默认值: "widget"]
  -h, --help     显示帮助信息                               

示例:
  object2md test/meta-widget-view.json #转换一个文件
  object2md test/                      #转换test目录下的所有json文件
  object2md test/ -t my.handlebars                     #使用自定义的my.handlebars模板转换

自定义handlebars模板转换

假设你的test.json文件定义如下

{
  "id":"1",
  "title":"hey,my friend"
}

那么转换模板my.handlebars可以这么写

# id属性值{{id}}
> 标题描述{{title}}

运行

object2md test.json -t my.handlebars

在md-dist目录会生成同名文件,内容为

# id属性值1
> 标题描述hey,my friend

Readme

Keywords

none

Package Sidebar

Install

npm i object2md

Weekly Downloads

1

Version

0.0.1

License

MIT

Unpacked Size

5.45 kB

Total Files

4

Last publish

Collaborators

  • lijing241