Output Markdown using console.log for CLI

log-md

Installation

npm install log-md

Usage

log-md parses the Markdown string and prints it to the terminal as styled, colorized text using console.log (headings, bold, italic, strikethrough, inline code, lists, and fenced code blocks), producing the output shown in the image above.

import {log} from 'log-md'

log(`
  # log-md

  This is a ~~test~~ file including some key features of
  [log-md](https://github.com/cezaraugusto/log-md):

  * Supports lists
  * Inline code like \`path.join()\`
  * Bold like **BOLD** and __italic__ too.

  Also supports multi-line code blocks:

  \`\`\`
    const path = require('path')
    path.join('bla', 'bla')
  \`\`\`

  ## Install

  See \`README.md\`

  Like it? Give it a ⭐️ (yes emojis work!)
`)

API

log(message, gutter?)

message

Type: string

The markdown message you want to parse.

gutter

Type: boolean
Default: false

Adds a line-break on top and bottom of your messages.

Related projects

• pintor
• mklicense
• prefers-yarn
• go-git-it
• git-precision
• isolated-deps

License

MIT (c) Cezar Augusto.