html

package
v1.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 12, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type MarkdownRenderer

type MarkdownRenderer struct {
	// contains filtered or unexported fields
}

MarkdownRenderer is a renderer that takes Markdown code and emits HTML. Use "NewMarkdownRenderer" to instantiate.

func NewMarkdownRenderer

func NewMarkdownRenderer(policy *bluemonday.Policy) MarkdownRenderer

func (*MarkdownRenderer) Render

func (r *MarkdownRenderer) Render(code []byte, transformer Transformer) ([]byte, error)

type PlaintextRenderer

type PlaintextRenderer struct {
	// contains filtered or unexported fields
}

PlaintextRenderer renders plaintext in a single "<pre>" element. Use "NewPlaintextRenderer" to instantiate.

func NewPlaintextRenderer

func NewPlaintextRenderer(policy *bluemonday.Policy) PlaintextRenderer

func (*PlaintextRenderer) Render

func (r *PlaintextRenderer) Render(code []byte, _ Transformer) ([]byte, error)

type Renderer

type Renderer interface {
	// Render processes "code" then returns HTML text.
	Render(code []byte, transformer Transformer) ([]byte, error)
}

type Transformer

type Transformer interface {
	// RewriteInternalMediaSource takes a site internal link to a media file
	// then returns a new link.
	RewriteInternalMediaSource(src string) string

	// RewriteInternalLink takes a site internal link then returns a new link.
	RewriteInternalLink(href string) string
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL