Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

livedown2

1.0.4 • Public • Published

Livedown2

Build Status Downloads

Originally based on shive/linedown.

Table of Contents

Overview

Easily render markdown documents using the command line (CLI) based on the next generation markdown parser in javascript, with pluggable syntax Markdown it!

  • Follows the CommonMark spec + adds syntax extensions & sugar (URL autolinking, typographer).
  • Configurable syntax! You can add new rules and even replace existing ones.
  • High speed.
  • Safe by default.
  • Community-written plugins and other packages on npm.

Demos

View the Live Demo to try it out or check out the screen capture below.

Installation

$ npm i -g livedown2

Usage

Typing either livedown or livedown2 will work.

$ livedown

Examples

Help

$ livedown -h

Specify port

$ livedown start README.md --port 4242

Open README.md preview in browser

$ livedown start README.md --open

Open README.md preview in a specific browser with arguments

This feature relies on specific CLI commands available for the browser of your choosing, e.g., --incognito for Google Chrome.

$ livedown start README.md --open --browser "'google chrome' --incognito"

Features

Installed Plugins

IDE Integrations

This package offers additional integrations for your favorite editors. Make sure to install the livedown2 package first, then follow the install instructions for each editor plugin.

Alternatives

License

MIT

Install

npm i livedown2

DownloadsWeekly Downloads

0

Version

1.0.4

License

MIT

Unpacked Size

113 kB

Total Files

24

Last publish

Collaborators

  • avatar