markdown-it-terminal

markdown-it-terminal
===

This is a plugin to provide ansi terminal output for markdown-it. It is heavily inspired by marked-terminal, a terminal renderer for the marked library.

__This library is not officially supported by markdown-it.__

Install

npm install markdown-it markdown-it-terminal

Usage

markdown-it provides a method for extending it with plugins.
``js
var markdown = require('markdown-it');
var terminal = require('markdown-it-terminal');

markdown.use(terminal);
`

You can override the default options if you choose.
`js
var styles = require('ansi-styles');
var markdown = require('markdown-it');
var terminal = require('markdown-it-terminal');

var options = {
styleOptions: {
code: styles.green
}
}
markdown.use(terminal, options);
// inline code now prints in green instead of the default yellow
`

Options

In the most basic implementation, you can simply provide a supported style like so:
`js
var styles = require('ansi-styles');

var options = {
styleOptions: {
code: styles.green
}
}
`
markdown-it-terminal exposes a utility method to build compound styles, using an array of style names (must be supported by ansi-styles).

`js
var styles = require('ansi-styles');
var terminal = require('markdown-it-terminal');

var options = {
styleOptions: {
code: terminal.compoundStyle(['green','underline'])
}
}
`

The following tokens can be overridden through styleOptions:
* code
* blockquote
* html
* heading
* firstHeading
* hr
* listitem
* table
* paragraph
* strong
* em
* codespan
* del
* link
* href

$3

# Heading 1
## Heading 2
Some stuff indented twice
#
Only indented once

Heading 1
  Heading 2
    Some stuff indented twice

  Only indented once