1.0.1 • Published 6 years ago

markdown-magic-figlet v1.0.1

Weekly downloads
33
License
MIT
Repository
github
Last release
6 years ago

FIGlet plugin

Add FIGfont text to markdown files via markdown-magic

Install

npm i -DE markdown-magic markdown-magic-figlet

Adding the plugin

See example.js for usage.

"use strict";

const path = require('path');
const markdownMagic = require('markdown-magic');
const { FIGLET } = require('./index.js');

const config = {
  transforms: {
    FIGLET: FIGLET({ variables: { foo: 'bar' } }),
  },
};

const markdownPath = path.join(__dirname, 'README.md');
markdownMagic(markdownPath, config);

Usage in markdown

Options

Transform factory options

  • variables: any object made of properties you can reuse in the rendered lodash template.

Content generator options

The options propagated to figlet.text options and use the same defaults.

The text option can be a lodash template.