Skip to content
forked from simman/md2min

convert markdown file to minimal html file

License

Notifications You must be signed in to change notification settings

hanghang/md2min

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.

About

convert markdown file to minimal html file

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 64.4%
  • Go 35.6%