# html2text [![Go Reference](https://pkg.go.dev/badge/github.com/inbucket/html2text.svg)](https://pkg.go.dev/github.com/inbucket/html2text) [![Build and Test](https://github.com/inbucket/html2text/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/inbucket/html2text/actions/workflows/build-and-test.yml) [![Report Card](https://goreportcard.com/badge/github.com/inbucket/html2text)](https://goreportcard.com/report/github.com/inbucket/html2text) ### Converts HTML into text of the markdown-flavored variety This is a permanent fork of the original [jaytaylor.com/html2text](https://github.com/jaytaylor/html2text) package. ## 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. It requires go 1.x or newer ;) ## Download the package ```bash go get github.com/inbucket/html2text ``` ## Example usage ### Library ```go package main import ( "fmt" "github.com/inbucket/html2text" ) func main() { inputHTML := ` My Mega Service

Welcome to your new account on my service!

Here is some more information:

Header 1Header 2
Footer 1Footer 2
Row 1 Col 1Row 1 Col 2
Row 2 Col 1Row 2 Col 2
` text, err := html2text.FromString(inputHTML, html2text.Options{PrettyTables: true}) if err != nil { panic(err) } fmt.Println(text) } ``` Output: ``` Mega Service ( http://jaytaylor.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 +-------------+-------------+ | HEADER 1 | HEADER 2 | +-------------+-------------+ | Row 1 Col 1 | Row 1 Col 2 | | Row 2 Col 1 | Row 2 Col 2 | +-------------+-------------+ | FOOTER 1 | FOOTER 2 | +-------------+-------------+ ``` ### Command line ``` echo '
hi
' | html2text ``` ## Unit-tests Running the unit-tests is straightforward and standard: ```bash go test ``` # License Permissive MIT license.