Git Product home page Git Product logo

md2min's Introduction

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.

md2min's People

Contributors

fairlyblank avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.