md-browse

A Markdown Viewer

This module adds a CLI command to enable quick reading markdown files in browser per double click and without starting a server.

Motivation

Often I want to read markdown docus on my disk. But I could not found a simple viewer. There are mostly editors. A good viewer is Shiba, but it have a long starting time and for each document is there a server running in background.

Because I could not found a simple viewer, I made it by my self and this is the result.

It uses Showdown to change markdown to HTML and highlight for highlighting. I had to make some coding to change local image links to absolute file:// links. Then it uses opn to open the result in browser.

I use it on Windows and I hope it runs also on Apple and Linux. Give me response

I :heart: love node and all the many people that make it grow.

Installation

Requires Node.js and a browser

npm install md-browse -g

Usage

mdbrowse <file>

In Windows, right click on a file and chose "open with". Then select the mdbrowse.cmd in your npm folder as application. You can retrieve this folder with: npm bin -g if you don't know. After that you can open markdown files with double click.

If you want to make a HTML file form a markdow file, call in like this

mdbrowse readme.md -g

this will create a readme.html it the same folder.

Configuration

You can set some options in config.js file, but it is not necessary. Read more

API

md-browse module exports some functions

References

• Style Documentation
• API Documentation
• highlight.js
• highlight CDN
• opn
• showdown

License

MIT