diff options
Diffstat (limited to 'vendor/github.com/mattermost/html2text/README.md')
| -rw-r--r-- | vendor/github.com/mattermost/html2text/README.md | 108 |
1 files changed, 0 insertions, 108 deletions
diff --git a/vendor/github.com/mattermost/html2text/README.md b/vendor/github.com/mattermost/html2text/README.md deleted file mode 100644 index 57abf3ff3..000000000 --- a/vendor/github.com/mattermost/html2text/README.md +++ /dev/null @@ -1,108 +0,0 @@ -# html2text - -[](https://godoc.org/github.com/cpanato/html2text) -[](https://travis-ci.org/cpanato/html2text) -[](https://goreportcard.com/report/github.com/cpanato/html2text) - -### Initial information - This project was forked from [github.com/jaytaylor/html2text](https://github.com/jaytaylor/html2text) in order to use another clean bom library due the original one has no license. - - -### Converts HTML into text - - -## Introduction - -Ensure your emails are readable by all! - -Turns HTML into raw text, useful for sending fancy HTML emails with a equivalently nicely formatted TXT document as a fallback (e.g. for people who don't allow HTML emails or have other display issues). - -html2text is a simple golang package for rendering HTML into plaintext. - -There are still lots of improvements to be had, but FWIW this has worked fine for my [basic] HTML-2-text needs. - -It requires go 1.x or newer ;) - - -## Download the package - -```bash -go get github.com/cpanato/html2text -``` - -## Example usage - -```go -package main - -import ( - "fmt" - - "github.com/cpanato/html2text" -) - -func main() { - inputHtml := ` - <html> - <head> - <title>My Mega Service</title> - <link rel=\"stylesheet\" href=\"main.css\"> - <style type=\"text/css\">body { color: #fff; }</style> - </head> - - <body> - <div class="logo"> - <a href="http://mymegaservice.com/"><img src="/logo-image.jpg" alt="Mega Service"/></a> - </div> - - <h1>Welcome to your new account on my service!</h1> - - <p> - Here is some more information: - - <ul> - <li>Link 1: <a href="https://example.com">Example.com</a></li> - <li>Link 2: <a href="https://example2.com">Example2.com</a></li> - <li>Something else</li> - </ul> - </p> - </body> - </html> - ` - - text, err := html2text.FromString(inputHtml) - if err != nil { - panic(err) - } - fmt.Println(text) -} -``` - -Output: -``` -Mega Service ( http://mymegaservice.com/ ) - -****************************************** -Welcome to your new account on my service! -****************************************** - -Here is some more information: - -* Link 1: Example.com ( https://example.com ) -* Link 2: Example2.com ( https://example2.com ) -* Something else -``` - - -## Unit-tests - -Running the unit-tests is straightforward and standard: - -```bash -go test -``` - - -# License - -Permissive MIT license. |