markdowntable – JSON 转 Markdown 表格的工具

目录

[TOC]

1. 使用方法

./markdowntable [-in jsonFilePath] [-out markdownFilePath]

选项:
  in: 输入JSON 文件,默认 "./info.json"
  out: 输出 markdown 文件,默认 "./info.md"

支持 MacOS, Linux 和 Windows 平台

2. 如何设置字段的内容?

2.1 以字符串结尾

如果一个字段的值不再包含子元素,值是 字符串,那么字符串就是字段的内容,插入到表格最后一列

2.2 以特定结构结尾

特定结构指:

{
    "header": "标题 - 这是一个标题",
    "desc": "描述 - 这是一个描述内容",
    "defaultValue": "默认值:Hello world",
    "options": [
        "字段接受的值1 - Hello world",
        "字段接受的值2 - 你好世界"
    ]
}

如果一个字段的值是以上的特定结构,那么该特定结构就是字段的内容,插入到表格最后一列。

说明:

"header" - 必须包含该字段
"desc" - 必须包含该字段
"defaultValue" - 可选字段
"options" - 可选字段, 支持数组

# 注:不支持自定义字段

3. 例子

以以下JSON 为例

{
    "1_1": {
        "1_2": {
            "1_3": {
                "header": "标题 - 第 1 行 第 4 列",
                "desc": "描述 - 这是一个描述内容",
                "defaultValue": "Hello world",
                "options": [
                    "Hello world",
                    "你好世界"
                ]
            },
            "2_3": {
                "2_4": "第 2 行 第 5 列",
                "3_4": "第 3 行 第 5 列"
            }
        },
        "4_2": {
            "4_3": {
                "4_4": "第 4 行 第 5 列",
                "5_4": "第 5 行 第 5 列"
            },
            "6_3": "第 6 行 第 4 列",
            "7_3": {
                "7_4": "第 7 行 第 5 列",
                "8_4": {
                    "header": "标题 - 第 8 行 第 5 列",
                    "desc": "描述 - 这是一个描述内容",
                    "defaultValue": "Hello world",
                    "options": [
                        "Hello world",
                        "你好世界"
                    ]
                }
            }
        }
    },
    "9_1": "第 9 行 第 2 列",
    "a0_1": {
        "a0_2": {
            "a0_3": {
                "a0_4": "第 10 行 第 5 列"
            }
        }
    },
    "a1_1": {
        "a1_2": "第 11 行 第 3 列"
    }
}

它将转换成 表格

参数 子参 子参 子参 释义
1_1 1_2 1_3 标题 – 第 1 行 第 4 列
描述 – 这是一个描述内容
默认:Hello world
可能的值:

  • Hello world
  • 你好世界
2_3 2_4 第 2 行 第 5 列
3_4 第 3 行 第 5 列
4_2 4_3 4_4 第 4 行 第 5 列
5_4 第 5 行 第 5 列
6_3 第 6 行 第 4 列
7_3 7_4 第 7 行 第 5 列
8_4 标题 – 第 8 行 第 5 列
描述 – 这是一个描述内容
默认:Hello world
可能的值:

  • Hello world
  • 你好世界
9_1 第 9 行 第 2 列
a0_1 a0_2 a0_3 a0_4 第 10 行 第 5 列
a1_1 a1_2 第 11 行 第 3 列

GitHub

View Github