gulp-markdown-table-to-json

A github-style-markdown table parse plugin for gulp 3/4

Special thanks to noraj

Usage

First, install gulp-markdown-table-to-json as a development dependency:

1npm install --save-dev gulp-markdown-table-to-json

Then, add it to your gulpfile.js:

Write Some Tables in Markdown File

Boys Table

name	age	grade
John	11	3
Bob	13	4

Girls Table

name	age	grade
Petra	15	8
Olivia	14	7

source code

1### Boys Table
2<!-- table2json:boys -->
3name | age| grade 
4-----|----|-----
5John|11|3
6Bob|13|4
7
8### Girls Table
9<!-- table2json:girls -->
10name | age| grade | 
11-----|----|-----
12Petra|15|8
13Olivia|14|7

Get Json

Gulp 3:

1const md2json = require('gulp-markdown-table-to-json');
2
3gulp.task('md2json', function(){
4  gulp.src('README.md')
5    .pipe(md2json())
6    .pipe(gulp.dest('.'));
7});

Gulp 4:

1const { src, dest, task} = require('gulp');
2const md2json = require('gulp-markdown-table-to-json');
3
4task(m2j);
5m2j.description = 'Markdown table to JSON';
6function m2j() {
7  return src('index.md')
8    .pipe(md2json())
9    .pipe(dest('.'));
10};

Then you will get a json file named README.json with the following content:

1{"boys":[{"name":"John","age":"11","grade":"3"},{"name":"Bob","age":"13","grade":"4"}],"girls":[{"name":"Petra","age":"15","grade":"8"},{"name":"Olivia","age":"14","grade":"7"}]}

You can also use "gulp-beautify" to beautify it:

1{
2    "boys": [{
3        "name": "John",
4        "age": "11",
5        "grade": "3"
6    }, {
7        "name": "Bob",
8        "age": "13",
9        "grade": "4"
10    }],
11    "girls": [{
12        "name": "Petra",
13        "age": "15",
14        "grade": "8"
15    }, {
16        "name": "Olivia",
17        "age": "14",
18        "grade": "7"
19    }]
20}

API

md2json(tableMarker)

tableMarker

Type: RegExp

The RegExp to search for table title. Default is /<!-- *table2json:([^ -]+) *-->/.