Output Formats

What Result contains for each Option.Type, and the separate path for JSON and XML documents.

Choosing a format

opt := &browser.Option{Type: browser.TypeMarkdown} // default
opt = &browser.Option{Type: browser.TypeHTML}      // merged HTML
opt = &browser.Option{Type: browser.TypeJSON}      // Result with a node tree, serialized into Content

Format details

TypeMarkdown

Readability runs on each snapshot after InlineTimeElements. Title, author, excerpt and publish time come from the first snapshot that parses; PublishedAt is RFC3339 when readability finds a date. When every snapshot parses but yields empty content, the merged raw HTML is converted instead. An empty final Markdown returns http 204. Conversion rules are on Content Conversion.

TypeHTML

No readability runs, so Title and the other metadata stay empty. The output keeps the full page structure, including navigation and scripts, with every later snapshot's <body> children appended after the first.

TypeJSON

The same readability content as Markdown is converted with HTMLToNode into a Node tree. The returned Result carries the metadata only inside the JSON string:

var full browser.Result
if err := json.Unmarshal([]byte(result.Content), &full); err != nil {
    return err
}
fmt.Println(full.Title, len(full.Tree))

Because the Markdown step still runs first, an empty Markdown result returns http 204 here too. The node schema is on Types.

JSON and XML documents

When document.contentType contains json or xml, settling, consent, scrolling and conversion are all skipped:

ContentType is set, and Type is ignored. If the extracted text is empty, the normal HTML path runs instead.