Minimal marked based unix terminal document viewer/pager with many features like markdown to terminal translation, file change watching and more.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
misc
tests
.eslintrc.json
.gitignore
.npmingnore
.travis.yml
LICENSE
README.md
dot-lessmd-sample.js
package.json

README.md

Lessmd

Donate npm version Build Status CircleCI Dependency Status Coverage Status dependencies Status devDependencies Status

asciicast

Lessmd - unix terminal document viewer/pager with markdown and piping support.

Why ?

  • It is JavaScript
  • Minimal and fast
  • Unix like pager with navigation
  • Displaying markdown with colors
  • Can translate markdown into colored output
  • Configurable user interface
  • Support files and pipes
  • With livereload (watching the file)
  • Markdown color theming support

Usage

Pager mode:

  lessmd README.md

Shortcuts:

  • q or ctrl+c exit

Piping with another programs:

  lessmd < README.md

Saving output into file for some prompt , motd, issue file.

 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 the home directory .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.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