Security News
Weekly Downloads Now Available in npm Package Search Results
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Reads a directory of markdown files with meta-data/front-matter and parses it out. Add your favorite templating language to make your own static site generator
Marky-mark helps you consume all your markdown files used for static-site generation.
It reads a directory of files with yaml meta-data/front-matter and parses it out. And if the extension is a markdown one it'll generate the html of that markdown. Add your favorite templating language to make your own static site generator.
If you would like to take ownership of this module or have publishing rights let me know.
Let's assume you have a folder of markdown files that optionally have front-matter/meta-data, looking something like this:
---
title: Marky Mark. A retrospective.
tags:
- music
- 90s
whatever: you want
---
## A Blog Post
A blog post about how I can't believe Mark Wahlberg is Marky Mark.
Written in markdown of course.
You can use marky-mark to easily grab all that data and stick it in an array of javascript objects.
var mm = require('marky-mark');
var posts = mm.parseDirectorySync(__dirname + "/path/to/posts");
or
var mm = require('marky-mark');
mm.parseDirectory(__dirname + "/path/to/posts", function(err, posts) {
console.log(posts);
});
The output will be an array of objects, with each object representing 1 file. The front-matter/meta-data is parsed via js-yaml. The parsed result is in the meta property, but the original yaml content is stored in the yaml property in case you want to do something with it.
// this is what .parseDirectorySync() and .parseDirectory() return
[
{
filename: "My Marky Mark post.md",
yaml: "title: Marky Mark. A retrospective.\ntags: ...",
markdown: "\n## A Blog Post\n\nA blog post about how I ...",
content: "<h2>A Blog Post</h2><p>A blog post about how I ...",
meta: {
title: "Marky Mark. A retrospective.",
tags: ["music", "90s"],
whatever: "you want"
}
},
{
// ... another file's contents ...
}
]
And that's it. It's up to you to do something with all the data marky-mark just read.
Parse all markdown files in a given directory, returning a list of context objects.
var mm = require('marky-mark');
var pages = mm.parseDirectorySync('./views/staticPages');
Like parseDirectorySync
, parses markdown files in a given directory, but accepts patterns for filtering.
var mm = require('marky-mark');
var pages = mm.parseMatchesSync('./views', ['posts/**/*.md', 'pages/**/*.md', '!**/README.md']);
Parse a single markdown file.
var mm = require('marky-mark');
var obj = mm.parseFileSync('./views/pages/faq.md');
Parse multiple markdown files
var mm = require('marky-mark');
var obj = mm.parseFilesSync(['./views/pages.faq.md', './views/pages/about-me.md']);
Parse a literal markdown string. This is a low-level function used internally by the library, but you might find an independent use for it.
var mm = require('marky-mark');
var obj = mm.parse('# A title\n\n## A subtitle');
Parse all markdown files in a given directory, returning a list of context objects.
var mm = require('marky-mark');
mm.parseDirectorySync('./views/staticPages', function(err, pages) {
});
Like parseDirectorySync
, parses markdown files in a given directory, but accepts patterns for filtering.
var mm = require('marky-mark');
mm.parseMatchesSync('./views', ['posts/**/*.md', 'pages/**/*.md', '!**/README.md'], function(err, pages) {
});
Parse a single markdown file.
var mm = require('marky-mark');
mm.parseFileSync('./views/pages/faq.md', function(err, obj) {
});
Parse multiple markdown files
var mm = require('marky-mark');
mm.parseFilesSync(['./views/pages.faq.md', './views/pages/about-me.md'], function(err, objs) {
});
All the above methods accept optional options
as the second parameter, where possible options include:
A synchronous usage with options:
var mm = require('marky-mark');
var obj = mm.parseFileSync('./views/pages/faq.md', {
marked: {
gfm: true, // Default
tables: false
},
preCompile: function(md) {
return md.replace('foo', 'bar');
}
});
An asynchronous usage with options:
var mm = require('marky-mark');
mm.parseFile('./views/pages/faq.md', {
context: {
// foo will be added to the "meta" object
foo: 'bar'
},
postCompile: function(html) {
return html.replace('h1', 'h2');
}
}, function(err, obj) {
});
Because marky-mark doesn't do anything but read and parse files meant for static-site generators, you'll want to pair it up with other sweet modules to create your own site generator (the funky-bunch approach).
Here are some suggested modules that are fun to use with marky-mark:
If you want to get even crazier, add an http server and a file-watching thing. Then you can generate your site automatically as you write, and see a live preview. Level up your system and automate your deployment.
Pull requests welcome!
npm install marky-mark
MIT
FAQs
Reads a directory of markdown files with meta-data/front-matter and parses it out. Add your favorite templating language to make your own static site generator
The npm package marky-mark receives a total of 4 weekly downloads. As such, marky-mark popularity was classified as not popular.
We found that marky-mark demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.