mccastles / jmc

Json to Markdown Converter

@linterhub/JMC

Table of Contents

• Background
• Install
• Usage
• Maintainers
• Contribute
• License

Background

Install

Usage

Use the following code example to convert JSON files to Markdown:

    let convert = require("@linterhub/JMC");

    convert('./examples/', './OutputDirectory/', false, undefined);
    /* all .json files from ./examples/ and subdirectories will be
    * converted and saved in ./OutputDirectory/examples/ */

• The first parameter is obligatory and contains the URI of the input JSON file or folder. It is possible to use mask to convert files only from given directory. For instance:

    convert('./examples/*.json');

• The second parameter is optional. If given, converted .md files will be saved according to the given path, copying the structure of original folder. The default output file name is markdowns.

• The third paramenter is optional. If true, the converter will try to convert meta-schema rather than object-describing one.

• The fourth parameter is optional. If given, custom template file will be taken into consideration. To customize converted Markdown files, custom template file should contain references to template .md files. For instance:

    "Title": "./src/defaultTemplates/Title.md",

Markdown syntax for the customization can be found here.

Maintainers

Contribute

License

MIT