marked-brunch-static

marked-brunch-static

Compile static markdown files with brunch.

marked-brunch-static is a processor for html-brunch-static, a brunch plugin designed to handle static html files. marked-brunch-static can convert markdown files into static html files with html-brunch-static's support for layouts and partial views.

Installation

marked-brunch-static depends on html-brunch-static, which also depends on brunch-static, so, you will need to install all three. The recommended method is via npm:

npm install --save-dev brunch-static html-brunch-static marked-brunch-static

Or manually:

• Add "brunch-static": "x.y.z" to package.json
• Add "html-brunch-static": "x.y.z" to package.json
• Add "marked-brunch-static": "x.y.z" to package.json
• Run npm install
• Alternatively, you may use the latest git version with:
  • "brunch-static": "git+ssh://[e-mail]:bmatcuk/brunch-static"
  • "html-brunch-static": "git+ssh://[e-mail]:bmatcuk/html-brunch-static"
  • "marked-brunch-static": "git+ssh://[e-mail]:bmatcuk/marked-brunch-static"

Configuration

Add marked-brunch-static to your list of html-brunch-static processors:

exports.config =
  ...
  plugins:
    static:
      processors: [
        require('html-brunch-static') {
          processors: [
            require('marked-brunch-static') {
              fileMatch: ...
              ...
            }
          ]
        }
      ]

Most options passed to marked-brunch-static are passed, verbatim, to marked, with the exception of:

• fileMatch (default: /\.static\.(?:markdown|mdown|mkdn|md|mkd|mdwn|mdtxt|mdtext|text)$/)

  fileMatch is an anymatch that is used to determine which files will be handled by this processor. As an anymatch, it may be a string with globs, a regex, or a function that takes a filename and returns true if it should be handled, or false otherwise. The default will match files that end in .static.markdown, .static.md, etc.