Skip to content

Extend the yaml-js parser with a markdown type. React-output is optional

License

Notifications You must be signed in to change notification settings

matthijsramlab/yaml-markdown

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

yaml-markdown

Extend the yaml-js parser with a markdown type, json-wrapped output is optional.

install

npm install yaml-markdown

usage

Use the custom !md and !md-json tags to load the markdown-files (the given path is relative to the .yml-file).

test_markdown: !md './example.md'
test_markdown_json: !md-json './example.md'

Use the exposed methods to load the yaml with the markdown-schema file.

    var loadYaml = require('../index.js');
    var path   = require('path');

    var p = path.join(__dirname, 'example.yml');

    loadYaml(p, function (data) {
        console.log(data);
    });

Additional options for the yaml-parser can be used via a third-attribute to the exposed function.

About

Extend the yaml-js parser with a markdown type. React-output is optional

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 100.0%