html2text

README

html2text

Converts HTML into text

Introduction

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

go get github.com/jaytaylor/html2text

Example usage

package main

import (
	"fmt"

	"github.com/jaytaylor/html2text"
)

func main() {
	inputHtml := `
	<div class="hard-to-read">
		Welcome to your new account on my service!
	</div>
	
	<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://example.com">Example.com</a></li>
			<li>Something else</li>
		</ul>
	</p>`
	text, err := html2text.FromString(inputHtml)
	if err != nil {
		panic(err)
	}
	fmt.Printf("input:\n\n%s\n\noutput:\n\n%s\n", inputHtml, text)
}

Output:

input:

    <div class="hard-to-read">
        Welcome to your new account on my service!
    </div>

    <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://example.com">Example.com</a></li>
            <li>Something else</li>
        </ul>
    </p>

output:

Welcome to your new account on my service!

Here is some more information:

Link 1:
https://example.com

Link 2:
https://example.com

Something else

Unit-tests

Running the unit-tests is straightforward and standard:

go test

License

Permissive MIT license.

Contact

You are more than welcome to open issues and send pull requests if you find a bug or want a new feature.

If you appreciate this library please feel free to drop me a line and tell me! It's always nice to hear from people who have benefitted from my work.

Email: jay at (my github username).com

Twitter: @jtaylor

Documentation

Index

• Variables
• func FromReader(reader io.Reader) (string, error)
• func FromString(input string) (string, error)
• func IsPreformatted(node *html.Node) bool
• type Formatter

Variables

var Formatters = map[string]Formatter{
	"_default": defaultFormatter{},
	"_text":    textFormatter{},
	"a":        aFormatter{},
	"br":       brFormatter{},
	"p":        pFormatter{},
	"li":       liFormatter{},
}

Formatters is the global formatter list.

Functions

func FromReader

func FromReader(reader io.Reader) (string, error)

func FromString

func FromString(input string) (string, error)

func IsPreformatted

func IsPreformatted(node *html.Node) bool

IsPreformatted returns true when a node belongs to a preformatted element (<pre>)

Types

type Formatter

type Formatter interface {
	Format(*html.Node, int) (string, error)
}

Formatter converts an html.Node to a string.