https://github.com/andschneider/mdp

markdown preview CLI
https://github.com/andschneider/mdp

go go-cli golang golang-cli markdown-previewer

Last synced: about 2 months ago
JSON representation

markdown preview CLI

• Host: GitHub
• URL: https://github.com/andschneider/mdp
• Owner: andschneider
• License: mit
• Created: 2020-07-03T05:41:45.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-07-26T03:28:13.000Z (over 5 years ago)
• Last Synced: 2024-06-20T01:50:09.974Z (over 1 year ago)
• Topics: go, go-cli, golang, golang-cli, markdown-previewer
• Language: Go
• Homepage:
• Size: 14.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# mdp

![Build](https://github.com/andschneider/mdp/workflows/Build/badge.svg)

[![Go Report Card](https://goreportcard.com/badge/github.com/andschneider/mdp)](https://goreportcard.com/report/github.com/andschneider/mdp)

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](https://github.com/andschneider/mdp/releases).

Or use `go get`:

```bash

go get github.com/andschneider/mdp

```

## Usage

- Pass in the name of the file you'd like to preview with the `-file` flag. 

```bash

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.

```bash

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](https://pragprog.com/titles/rggo/)