summaryrefslogtreecommitdiffstats
path: root/vendor/github.com/writeas/go-strip-markdown/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/github.com/writeas/go-strip-markdown/README.md')
-rw-r--r--vendor/github.com/writeas/go-strip-markdown/README.md51
1 files changed, 51 insertions, 0 deletions
diff --git a/vendor/github.com/writeas/go-strip-markdown/README.md b/vendor/github.com/writeas/go-strip-markdown/README.md
new file mode 100644
index 00000000..41664c52
--- /dev/null
+++ b/vendor/github.com/writeas/go-strip-markdown/README.md
@@ -0,0 +1,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.