Categorygithub.com/jmcfarlane/markdown
repositorypackage
0.0.0-20241208161703-659f16a89c5e
Repository: https://github.com/jmcfarlane/markdown.git
Documentation: pkg.go.dev

# README

Markdown

Go Report Card

This is a tool to render markdown files locally, for use with iteration prior to pushing changes to version control.

  1. All markdown rendering occurs locally

Installation

$ go install github.com/jmcfarlane/markdown@latest

Usage

$ cd ~/where/your/docs/are
$ markdown

Point your browser at: http://localhost:8080. Click around, refresh the page as you make changes.

Help

$ 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")

Credit

This program doesn't really do much of anything. All the actual work is done by:

As well as things ^ depend upon.

Inspired by: https://github.com/joeyespo/grip