Giter Club home page Giter Club logo

markovic's Introduction

marković

Build Status GoDoc

Go wrapper for libcmark, a CommonMark parsing and rendering library.

Installation

$ go get github.com/subosito/markovic

Usage

r := strings.NewReader("# Hello")
s := markovic.HTML(r)

fmt.Println(s) // Output: <h1>Hello</h1>\n

Supported formats:

  • markovic.HTML: render markdown as HTML document
  • markovic.XML: render markdown as XML document
  • markovic.Man: render markdown as GNU roff (groff) man page
  • markovic.CommonMark: render markdown as CommonMark document
  • markovic.LaTeX: render markdown as LaTeX document

Alternatives

  • go-commonmark: While both are wrapper for libcmark, each of them use different paradigm. go-commonmark is full-featured wrapper, while marković tries to be very simple.
  • blackfriday: Pure Go markdown parser, very popular. Not fully CommonMark compatible yet.
  • mmark: Another pure Go markdown parser, originally forked from blackfriday. Adds additional features.

Benchmarks

$ go test -bench=.                                                 
BenchmarkHTML_Markovic-4          500000              2868 ns/op                            
BenchmarkHTML_BlackFriday-4       500000              2562 ns/op                            
BenchmarkHTML_MMark-4             500000              2375 ns/op                            
PASS                                                                                        
ok      github.com/subosito/markovic    4.011s

markovic's People

Watchers

 avatar  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.