Skip to content
🚚 Parse the markdown into a JSON static file.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
lib
samples
.editorconfig
.gitignore
CHANGELOG.md
README.md
package.json
tsconfig.json
yarn.lock

README.md

mark-to-json NpmVersion NodeVersion

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

Changelog

You can’t perform that action at this time.