Skip to content

Latest commit

 

History

History
64 lines (37 loc) · 1.17 KB

README.md

File metadata and controls

64 lines (37 loc) · 1.17 KB

md2min

convert markdown file to minimal html file, using github css.

install

go get github.com/fairlyblank/md2min

If you want to build standalone execution:

cd $(GOPATH)/github.com/fairlyblank/md2min/main
go build -o md2min

usage

As standalone execution:

Usage: md2min [-nav=h2] name.md
  name.md: markdown file name
  -nav="none": navigate level ["none", "h1", "h2", "h3", "h4", "h5", "h6"]

As package, please review main.go.

Generally:

1. Prepare input byte slice and output writer

bytes, _ := ioutil.ReadAll(filename)
wr, _ := os.Create(newname)

2. Initialize package

Without navigator:

md := md2min.New("none")

Using "<h2>" tag as navigator:

md := md2min.New("h2")

3. Parse

md.Parse(bytes, wr)

examples

md2min ./example/example.md

will generate html without navigator.

md2min -nav=h2 ./example/example.md

will generate html with "<h2>" title navigator.

About

md2min is written in Google Go.

md2min is open source software released under the MIT License.