markdown-serve

Module: markdown-serve/parser

markdown-serve/parser

Handles Markdown file parsing, extracting out the YAML front-matter and parsing the content converting to HTML

Source:

Requires

  • module:fs
  • module:js-yaml
  • module:marked
  • module:highlight.js
  • module:lodash
  • module:crypto
  • module:path
  • module:mkdirp

Members

<static> MarkdownFile

MarkdownFile

Source:

Methods

<static> parse(file, markedOptions, callback) → {MarkdownFile}

Attempts to load a MarkdownFile

Parameters:
Name Type Argument Description
file string

Full path to file to load
markedOptions Object <optional>
<nullable>

Optional options to pass to "marked" module for Markdown processing
callback parseCallback

parseCallback
Source:
Returns:
Type
MarkdownFile

Type Definitions

parseCallback(err, result)

parse() callback

Parameters:
Name Type Argument Description
err Object <nullable>

Errors if any
result MarkdownFile
Source: