DEPRECATED! ALL OFFICIAL PLUGINS NOW LIVE IN CORE

@weh/markdown

A Markdown parsing plugin for the weh static site generator

Features

• Parse Markdown content in text files within the weh files array
• Custom filter functions to include or exclude files from transforms

Installation

npm install --save @weh/markdown

Usage example

const weh = require('@weh/weh')
const markdown = require('@weh/markdown')

// enter our main function:
// the main function should be an async function so that
// it automatically returns a promise
weh(async site => {
  // we register our plugin...
  site.use(markdown)
  // ...and initiate the build process
  return site
})

Filter example

You can pass a custom filter as an option to markdown to include or exclude files.

A filter is a function that takes the arguments file, options, and files. file is the current file, options is the options object passed to markdown, and files is the entire array of files created by weh.

If the filter function returns true, markdown applies its transforms to the contents of the current file object. Otherwise the file object remains unchanged.

The default filter in markdown returns true only for files ending with .md:

function myCustomFilter (file, options, files) {
  return file.path.endsWith('.md')
}

This is how you could use a filter to apply markdown to every file:

const weh = require('@weh/weh')
const markdown = require('@weh/markdown')

// custom filter function
// always returns true
function myCustomFilter (file, options, files) {
  return true
}

weh(async site => {
  // we register the markdown plugin with our custom filter function...
  site.use(markdown, {filter: myCustomFilter})
  // ...and initiate the build process
  return site
})

All processed files are renamed to <filename>.html after being converted.

Development

To work on this repository, clone it and install the npm dependencies:

git clone https://github.com/wehjs/markdown weh-markdown
cd weh-markdown
npm install

There are a couple of npm scripts provided for convenience:

• npm test - runs linters and ava in ci mode
• npm run lint - runs linters
• npm run ava - only runs ava once
• npm run ava:ci - runs ava in ci mode (generates coverage data)
• npm run ava:watch - runs ava in watch mode
• npm run coverage - generates coverage data
• npm run update-coc - pulls the latest weallbehave code of conduct
• npm run deploy - publishes npm package using np

Maintainers

• Frederic Marx <marx.frederic@gmail.com>

Code of Conduct

This repository operates under the weallbehave Code of Conduct. Its contents can be found in CODE_OF_CONDUCT.md.

License

MIT (see LICENSE document)