CyberGocybergodev/html

English

简体中文
한국어
日本語
Русский

English

简体中文
한국어
日本語
Русский

Theme

English

简体中文
한국어
日本語
Русский

Quick Start ​

Installation ​

bash
go get github.com/cybergodev/html

Requires Go 1.25+.

Basic Extraction ​

Extract content from HTML bytes:

go
package main

import (
    "fmt"
    "log"

    "github.com/cybergodev/html"
)

func main() {
    data := []byte(`<html>
        <head><title>Go Tutorial</title></head>
        <body>
            <article>
                <h1>Getting Started with Go</h1>
                <p>Go is a statically typed compiled language.</p>
                <img src="gopher.png" alt="Gopher" />
                <a href="https://go.dev">Go Official Site</a>
            </article>
        </body>
    </html>`)

    result, err := html.Extract(data)
    if err != nil {
        log.Fatal(err)
    }

    fmt.Println("Title:", result.Title)
    fmt.Println("Text:", result.Text)
    fmt.Println("Images:", len(result.Images))
    fmt.Println("Links:", len(result.Links))
    fmt.Println("Words:", result.WordCount)
}

Output:

text
Title: Go Tutorial
Text: Getting Started with Go

Go is a statically typed compiled language.

Go Official Site
Images: 1
Links: 1
Words: 14

Extract from File ​

go
result, err := html.ExtractFromFile("page.html")
if err != nil {
    log.Fatal(err)
}

Using Configuration ​

Customize extraction behavior with Config:

go
cfg := html.MarkdownConfig()
p, err := html.New(cfg)
if err != nil {
    log.Fatal(err)
}
defer p.Close()

result, err := p.Extract(data)

Configuration Presets ​

PresetFunctionDescription
DefaultDefaultConfig()Balanced configuration for general use
TextTextOnlyConfig()Extract plain text only, disable media
MarkdownMarkdownConfig()Optimized for Markdown output
High SecurityHighSecurityConfig()Strict limits, full audit

Output Formats ​

go
// Plain text
text, err := html.ExtractText(data)

// Markdown
md, err := html.ExtractToMarkdown(data)

// JSON
jsonBytes, err := html.ExtractToJSON(data)

Context Support ​

All functions have ExtractWithContext variants that support cancellation and timeout:

go
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()

result, err := html.ExtractWithContext(ctx, data)

Key Notes ​

Concurrency Safety ​

Processor instances are concurrent-safe and can be shared across goroutines:

go
p, err := html.New(html.DefaultConfig())
if err != nil {
    log.Fatal(err)
}
defer p.Close()

// Safe to call from multiple goroutines
var wg sync.WaitGroup
for _, url := range urls {
    wg.Add(1)
    go func(u string) {
        defer wg.Done()
        result, err := p.Extract(fetchHTML(u))
        // ...
    }(url)
}
wg.Wait()

Package-level functions are also concurrent-safe (internally use a Processor pool).

Encoding Detection ​

The library automatically detects HTML encoding — no manual handling needed:

go
// GBK-encoded HTML is automatically detected and correctly extracted
result, err := html.Extract(gbkData)

// You can also manually specify encoding via Config.Encoding
cfg := html.DefaultConfig()
cfg.Encoding = "gbk"

Supports UTF-8, GBK, GB18030, Shift_JIS, EUC-JP, Windows-1252, and 15+ encodings.

Next Steps ​