Code Monkey home page Code Monkey logo

mdview's Introduction

Markdown View

Snap Status

Formats markdown and launches it in a browser.

Installation

Arch Linux (and derivatives)

Mdview is now available in the AUR
If you have an AUR helper like yay, installing is as easy as:

yay -S mdview

Debian Package

If you're running Debian or a derivative like Ubuntu or Pop!_OS, download the deb package.

curl -O https://github.com/mapitman/mdview/releases/download/1.4.0/mdview-1.4.0_amd64.deb
sudo dpkg --install mdview-1.4.0_amd64.deb

To remove the package:

sudo dpkg --remove mdview

Snap Package

On Linux, you can install mdview from the snap store. This option is only viable if the files you want to view are in your home directory. If you need to view files in other locations, try an alternate installation method.

Note: A side effect of the sandboxing of Snap packages is that every time mdview is executed, Snap will prompt to allow writing the temporary file. If that is not acceptable, please choose an alternate installation method.

Get it from the Snap Store

sudo snap install mdview

Don't have snapd? Get set up for snaps.

Manual Download and Install

Grab the correct binary for your operating system here.

Compile Yourself

If you have Golang installed...

go get github.com/mapitman/mdview

Don't have Golang? Get it now.

Usage

Usage:
mdview [options] <filename>
Formats markdown and launches it in a browser.
  -b    Bare HTML with no style applied.
  -bare
        Bare HTML with no style applied.
  -h    Prints mdview help message.
  -help
        Prints mdview help message.
  -o string
        Output filename. (Optional)
  -v    Prints mdview version.
  -version
        Prints mdview version.

If you do not supply an output file, mdview will write a file to your operating system's default temp directory.

mdview's People

Contributors

mapitman avatar eaglersdeveloper avatar evandandrea avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.