format

package

v0.0.0-...-c20b901 Latest Latest Go to latest Published: Jul 28, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package format contains all currently implemented format options.

This section is empty.

This section is empty.

This section is empty.

type HTML struct{}

HTML implements a format taking html source and transforming it into save html.

func (h HTML) Format(b []byte) template.HTML

Format returns save html.

func (h HTML) FormatClean(b []byte) template.HTML

FormatClean returns a save version, stripped of most formatting tags.

type Markdown struct{}

Markdown takes input in the markdown format (including some extensions) and returns save HTML.

func (m Markdown) Format(b []byte) template.HTML

Format returns a save html version of the Markdown input.

func (m Markdown) FormatClean(b []byte) template.HTML

FormatClean returns a save html version of the Markdown input. Most formatting is stripped from the output.

type Plain struct{}

Plain is a formatting which wraps the plain input into HTML.

func (p Plain) Format(b []byte) template.HTML

Format returns a save html version of the input.

func (p Plain) FormatClean(b []byte) template.HTML

FormatClean returns a save html version of the input.