Skip to content
A small markdown viewer/converter for unix terminal.
JavaScript
Branch: master
Clone or download
linuxenko 1.2.2 (#10)
* v1.2.2

* v1.2.2
Latest commit 38b1b4f Nov 2, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin [1.0.0] forgotten commit Oct 26, 2016
lib
misc Add files via upload Oct 25, 2016
tests Make travis pass this tests Nov 1, 2019
.eslintrc.json
.gitignore Dependencies update Nov 1, 2019
.npmingnore ---- Oct 23, 2016
.travis.yml Update node's version Nov 1, 2019
LICENSE Initial commit Oct 20, 2016
README.md Update node's version Nov 1, 2019
dot-lessmd-sample.js
package.json 1.2.2 (#10) Nov 2, 2019

README.md

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

You can’t perform that action at this time.