vendor/github.com/writeas/go-strip-markdown/README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

# go-strip-markdown

[![GoDoc](https://godoc.org/github.com/writeas/go-strip-markdown?status.svg)](https://godoc.org/github.com/writeas/go-strip-markdown)

A Markdown stripper written in Go (golang).

## Usage
You could create a simple command-line utility:

```go
package main

import (
	"fmt"
	"github.com/writeas/go-strip-markdown"
	"os"
)

func main() {
	if len(os.Args) < 2 {
		os.Exit(1)
	}
	fmt.Println(stripmd.Strip(os.Args[1]))
}
```

You could pass it Markdown and get pure, beauteous text in return:

```bash
./strip "# A Tale of Text Formatting

_One fateful day_ a developer was presented with [Markdown](https://daringfireball.net/projects/markdown/).
And they wanted **none of it**."

# A Tale of Text Formatting
#
# One fateful day a developer was presented with Markdown.
# And they wanted none of it.
```

## Inspiration
This was largely based off of [remove-markdown](https://github.com/stiang/remove-markdown), a Markdown stripper written in Javascript.

## Used by

This library is used in these projects:

* [WriteFreely](https://github.com/writeas/writefreely)

## License
MIT.