kynde / lessmd Goto Github PK

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

• 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

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

  npm install -g lessmd

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
};

MIT (c) Svetlana Linuxenko