This is a tool to render markdown files locally, for use with iteration prior to pushing changes to version control.
- All markdown rendering occurs locally
- Your browser will fetch some static assets from the internet:
$ go install github.com/jmcfarlane/markdown@latest
$ cd ~/where/your/docs/are
$ markdown
Point your browser at: http://localhost:8080. Click around, refresh the page as you make changes.
$ markdown -h
Usage of markdown:
-index string
Index (or default) markdown file name (default "README.md")
-listen string
Interface:port to listen on (default ":8080")
This program doesn't really do much of anything. All the actual work is done by:
- https://github.com/russross/blackfriday
- https://github.com/shurcooL/github_flavored_markdown/
- https://golang.org/
As well as things ^ depend upon.
Inspired by: https://github.com/joeyespo/grip