markdownd

command module
v0.3.1 Latest Latest
Warning

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

Go to latest
Published: Sep 1, 2021 License: MIT Imports: 16 Imported by: 0

README

markdownd

markdownd is a markdown renderer for your command-line. It can also serve the rendered markdown to your browser and reload it automatically when the file changes.

Installation

For now, you need to install from source. With Go 1.16+, run

go install github.com/cespare/markdownd@latest

Protips

Here are two lines I use in my .vimrc to make it really quick to open the current markdown file in a browser and have it auto-refresh when the file changes:

command! Markdownd !markdownd -w % >/dev/null &
noremap <leader>m :Markdownd<cr><cr>

Note that when you use markdownd -w to watch a file, the server will exit as soon as you close the web browser tab so you don't need to worry about extra markdownd servers hanging around.

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