mdp

command module
v0.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 26, 2020 License: MIT Imports: 13 Imported by: 0

README

mdp

Build Go Report Card

A simple CLI that will preview a markdown file in a browser.

Installation

There are binaries for Linux, Mac, and Windows in the releases page.

Or use go get:

go get github.com/andschneider/mdp

Usage

  • Pass in the name of the file you'd like to preview with the -file flag.
mdp -file README.md
  • To skip the autopreview use the -skip flag. This also doesn't remove the generated .html file if you'd like to save or view it later.

  • Use -help flag to display the full usage information.

mdp - preview markdown in your browser.

Usage information:
  -file string
    	Markdown file to preview.
  -skip
    	Skip auto-preview and prevent auto-delete of html file.
  -version
    	Print version and exit.
inspiration

This repo is based on chapter 3 from the book Powerful Command-Line Applications in Go

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL