Skip to content

Commit 19233c7

Browse files
committed
jsdoc for markdown_parser
1 parent 9c44844 commit 19233c7

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

core/lib/markdown_parser.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,11 @@ var yaml = require('js-yaml');
55

66
var markdown_parser = function () {
77

8+
/**
9+
* Converts a markdown block with frontmatter (each is optional, technically) to a well-formed object.
10+
* @param block - the ".md" file, which can contain frontmatter or not, or only frontmatter.
11+
* @returns an object with any frontmatter keys, plus a .markdown key
12+
*/
813
function parseMarkdownBlock(block) {
914
var returnObject = {};
1015

0 commit comments

Comments
 (0)