diff options
Diffstat (limited to 'vendor/github.com/jaytaylor/html2text/README.md')
| -rw-r--r-- | vendor/github.com/jaytaylor/html2text/README.md | 94 |
1 files changed, 61 insertions, 33 deletions
diff --git a/vendor/github.com/jaytaylor/html2text/README.md b/vendor/github.com/jaytaylor/html2text/README.md index 6e67dbcc6a..90848faadb 100644 --- a/vendor/github.com/jaytaylor/html2text/README.md +++ b/vendor/github.com/jaytaylor/html2text/README.md @@ -4,11 +4,15 @@ [](https://travis-ci.org/jaytaylor/html2text) [](https://goreportcard.com/report/github.com/jaytaylor/html2text) -### Converts HTML into text +### Converts HTML into text of the markdown-flavored variety ## Introduction +Ensure your emails are readable by all! + +Turns HTML into raw text, useful for sending fancy HTML emails with an 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. @@ -19,7 +23,7 @@ It requires go 1.x or newer ;) ## Download the package ```bash -go get github.com/jaytaylor/html2text +go get jaytaylor.com/html2text ``` ## Example usage @@ -30,39 +34,51 @@ package main import ( "fmt" - "github.com/jaytaylor/html2text" + "jaytaylor.com/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) + 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://jaytaylor.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> + + <table> + <thead> + <tr><th>Header 1</th><th>Header 2</th></tr> + </thead> + <tfoot> + <tr><td>Footer 1</td><td>Footer 2</td></tr> + </tfoot> + <tbody> + <tr><td>Row 1 Col 1</td><td>Row 1 Col 2</td></tr> + <tr><td>Row 2 Col 1</td><td>Row 2 Col 2</td></tr> + </tbody> + </table> + </body> +</html>` + + text, err := html2text.FromString(inputHTML, html2text.Options{PrettyTables: true}) if err != nil { panic(err) } @@ -72,7 +88,7 @@ func main() { Output: ``` -Mega Service ( http://mymegaservice.com/ ) +Mega Service ( http://jaytaylor.com/ ) ****************************************** Welcome to your new account on my service! @@ -83,6 +99,15 @@ Here is some more information: * Link 1: Example.com ( https://example.com ) * Link 2: Example2.com ( https://example2.com ) * Something else + ++-------------+-------------+ +| HEADER 1 | HEADER 2 | ++-------------+-------------+ +| Row 1 Col 1 | Row 1 Col 2 | +| Row 2 Col 1 | Row 2 Col 2 | ++-------------+-------------+ +| FOOTER 1 | FOOTER 2 | ++-------------+-------------+ ``` @@ -110,3 +135,6 @@ Email: jay at (my github username).com Twitter: [@jtaylor](https://twitter.com/jtaylor) +# Alternatives + +https://github.com/k3a/html2text - Lightweight |