Meet npm Pro: unlimited public & private packages + package-based permissions.Learn more »

lessmd

1.2.2 • Public • Published

Lessmd

npm version Build Status Coverage Status dependencies Status devDependencies Status

asciicast

Lessmd is a terminal viewer/pager with markdown and piping support.

Why ?

  • It is a JavaScript
  • Minimal and fast
  • Unix like pager with navigation
  • Displays markdown with colors
  • Can translate markdown into colored output
  • Configurable user interface
  • Supports files and pipes
  • With livereload (watch filechanges)
  • Markdown theming support

Usage

Pager mode:

  lessmd README.md

Shortcuts:

  • q or ctrl+c exit

Piping with another programs:

  lessmd < README.md

To save some output into a file, which you can use as a motd or an issue files.

 echo "# welcome\n * do not touch anything \n * just press Ctrl+D" \
 | lessmd | tee /etc/motd

pipe example

Installation

  npm install -g lessmd

Configuration

Lessmd looks for user settings inside of a home directory, the filename is .lessmd.js.

Example of the .lessmd.js:

module.exports = {
  colors : {    /// markdown theming colors
    text : ,    
    lang : ,
    heading : ,
    code : ,
    quote : ,
    em : ,
    codespan : ,
    strong : ,
    html : ,
    del : ,
    link : ,
    hr : ,
    listitem :,
  },
  theme : {
    draw : false       // disable any ui (header and footer bars)
    text : '',         // text style
    strong : ''        // bold text style
  },
  headerfn : function() { return 'header'; }, // custom header fn,
  footerfn : function() { return 'footer'; }  // custom footer fn
};

ChangeLog

1.2.1

  • Dependencies update

1.2.0

  • Bug with long slices

1.1.0 - 2016-11-15

  • Html options for marked (sanityze, smartypants)
  • h,j,k,l bindings
  • Smaller chunks colorization for view mode

1.0.1 - 2016-11-03

  • Added original less keybindings

License

MIT (c) Svetlana Linuxenko

Install

npm i lessmd

DownloadsWeekly Downloads

8

Version

1.2.2

License

MIT

Unpacked Size

22.8 kB

Total Files

14

Last publish

Collaborators

  • avatar