mdlog
Markdown on console.log
What Is?
; console;
then terminal output is:
and browser output is:
Install
$ npm install --save mdlog
--save
option is optional.
API
mdlogBuilder = ;
mdlog = mdlogBuilder(colorScheme)
mdlogBuilder
is builder of mdlog
function.
An argument colorScheme
is color scheme Object
(see color directory),
its default value is colorScheme = require('mdlog/color/default.json')
.
It returns mdlog
function.
mdlog(markdown)
mdlog
output styled markdown text into console
.
It uses mdlogBuilder.conver
function to convert Markdown text into styled text.
It returns undefined
.
mdlogBuilder.convert(markdown, colorScheme)
convert
converts markdown
text into styled text with colorScheme
.
It uses mdast as Markdown parser.
It returns an Array
to pass into console.log
as arguments.
require('mdlog/override')
console.log
overrides mdlog
. This module pollutes global console
object. You can use original console.log
as console._log
.
License
MIT License. See https://makenowjust.github.io/license/mit?2015.