Mark-to-json NPM

mark-to-json

Parse the markdown into a JSON static file, also support multiple-level directories.

Installing

# npm
npm i mark-to-json --save

# yarn
yarn add mark-to-json

Usage

API	Required	default	Description
token	true		Your markdown file content including yaml matter
dest	false	`./default.json`	Your JSON static file will be created at the place based on the current nodejs working path
extraHeader	false	`{}`	It will be mix in JSON file if you want to add some extra data to JSON static file
contentKey	false	`content`	It will be the key of markdown content part in JSON static file
filter	false		It can be used to change output schema (sample).

Sample

const Mtj = require('mark-to-json')

new Mtj({
  token: '---\ntitle: Hello world\n---\nThis is content.',
  dest: './writings/hello-world.json',
  extraHeader: {
    errno: 0
  },
  contentKey: 'content',

  // Only work with one parameter: schema
  filter (schema) {
    // do something
    // `return` is optional
  }
})

// You can find your json file at the './writings/hello-world.json' based on the current nodejs working path

The sample output file: here

Changelog

mark-to-json markdown json parser yaml parse-matter documentation docs files

chalk gray-matter mkdirp

@infinitebrahmanuniverse/nolb-mark-@everything-registry/sub-chunk-2131 @zalastax/nolb-mark-docs-server

6 years ago

6 years ago

6 years ago

6 years ago