readme-view

1.0.1 • Public • Published

readme-view

A command-line tool for previewing README.md files in a web browser.

Installation:

  • To use readme-view, open your terminal and run command:
  • npm install readme-view or npm install -g readme-view

Usage:

  • Once installed, you can use the pre-md command followed by the path to your README.md file. For example:
  • pre-md README.md
  • This will generate an HTML preview of your README.md file and open it in your default web browser.

Dependencies

  • opn
  • markdown-it

Readme

Keywords

none

Package Sidebar

Install

npm i readme-view

Weekly Downloads

4

Version

1.0.1

License

ISC

Unpacked Size

2.32 kB

Total Files

4

Last publish

Collaborators

  • suraj_chandra