<commit_before># Mark
> A [markdown](http://daringfireball.net/projects/markdown/) processor written in Go. built for fun.

This project ispired from [<NAME> - Lexical Scanning talk](https://www.youtube.com/watch?v=HxaD_trXwRE) and [marked](https://github.com/chjj/marked) project.  
Please note that this is a __WIP__ project and any contribution is welcomed and appreciated,
so feel free to take some task here.

## Table of contents:
- [Usage](#get-started)
- [Todo](#todo)

### Usage
#### Installation
```sh
$ go get github.com/a8m/mark
```
#### Add to your project
```go
import (
	"fmt"
	"github.com/a8m/mark"
)

func main() {
	html := mark.Render("I am using __markdown__.")
	fmt.Println(html)
	// <p>I am using <strong>markdown</strong>.</p>
}
```


### Todo
- Backslash escape
- Configuration options
	- gfm, table
	- heading(auto hashing)
	- smartypants
	- etc...
- __v0.2.0__ - Regex is slowww, we should leave it.


### License
MIT



<commit_msg>add badges<commit_after># Mark
[![Test coverage][coveralls-image]][coveralls-url]
[![Build status][travis-image]][travis-url]
> A [markdown](http://daringfireball.net/projects/markdown/) processor written in Go. built for fun.

This project ispired from [<NAME> - Lexical Scanning talk](https://www.youtube.com/watch?v=HxaD_trXwRE) and [marked](https://github.com/chjj/marked) project.  
Please note that this is a __WIP__ project and any contribution is welcomed and appreciated,
so feel free to take some task here.

## Table of contents:
- [Usage](#get-started)
- [Todo](#todo)

### Usage
#### Installation
```sh
$ go get github.com/a8m/mark
```
#### Add to your project
```go
import (
	"fmt"
	"github.com/a8m/mark"
)

func main() {
	html := mark.Render("I am using __markdown__.")
	fmt.Println(html)
	// <p>I am using <strong>markdown</strong>.</p>
}
```


### Todo
- Backslash escape
- Configuration options
	- gfm, table
	- heading(auto hashing)
	- smartypants
	- etc...
- __v0.2.0__ - Regex is slowww, we should leave it.


### License
MIT

[travis-url]: https://travis-ci.org/a8m/mark
[travis-image]: https://img.shields.io/travis/a8m/mark.svg?style=flat-square
[coveralls-image]: https://img.shields.io/coveralls/a8m/mark.svg?style=flat-square
[coveralls-url]: https://coveralls.io/r/a8m/mark

{'fraction_non_alphanumeric': 0.1663716814159292, 'fraction_numerical': 0.006194690265486726, 'mean_word_length': 4.069506726457399, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 15, 'https://': 8, 'lorem ipsum': 0, 'www.': 4, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '432190', 'n_tokens_mistral': 847, 'n_tokens_neox': 810, 'n_words': 207}