markdown-magic-figlet

1.0.1 • Public • Published

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.

Package Sidebar

Install

npm i markdown-magic-figlet

Weekly Downloads

0

Version

1.0.1

License

MIT

Unpacked Size

25.6 kB

Total Files

13

Last publish

Collaborators

  • atondelier