markdown-api-parser

Takes markdown files and generates a data set suitable for using as an API.

Install

npm install markdown-api-parser

Usage

For ES2015 / ES6:

import { processFiles } from 'markdown-api-parser';
processFiles('example/markdown/*.md').then(data => console.log(data));

ES5:

var processFiles = require('markdown-api-parser').processFiles;
processFiles('example/markdown/*.md').then(function(data) { console.log(data) });

Input

markdown/example.md

<!---
name: First!
tags: test, blog
published: 19.02.2015, 18:45
-->
# Welcome to my blog
Hello

markdown/example2.md

<!---
name: Example 2
-->
# Example 2

Output

[ 
  { 
    file: 'markdown/example.md',
    data: '# Welcome to my blog\nHello\n',
    name: [ 'First!' ],
    tags: [ 'test', 'blog' ],
    published: [ '19.02.2015', '18:45' ] 
  },
  { 
    file: 'markdown/example2.md',
    data: '# Example 2\n',
    name: [ 'Example 2' ] 
  } 
]

Custom parser

import { processFiles } from 'markdown-api-parser';

function countLines(filename, content) {
    const lines = content.toString('utf8').split('\n').length;
    return {filename, lines};
};

processFiles('example/markdown/*.md', countLines).then(d => console.log(d));

Example output

[ 
  { filename: 'markdown/example.md', lines: 7 },
  { filename: 'markdown/example2.md', lines: 4 } 
]