5
0
mirror of https://github.com/cwinfo/matterbridge.git synced 2024-11-30 06:11:36 +00:00
matterbridge/vendor/github.com/writeas/go-strip-markdown/README.md
Wim ba0bfe70a8
Add StripMarkdown option (irc). (#1145)
Enable `StripMarkdown` to strip markdown for irc.
2020-05-23 21:46:15 +02:00

52 lines
1.1 KiB
Markdown

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