format

Documentation

Overview

Package format contains all currently implemented format options.

Index

• type HTML
  • func (h HTML) Format(b []byte) template.HTML
  • func (h HTML) FormatClean(b []byte) template.HTML
• type Markdown
  • func (m Markdown) Format(b []byte) template.HTML
  • func (m Markdown) FormatClean(b []byte) template.HTML
• type Plain
  • func (p Plain) Format(b []byte) template.HTML
  • func (p Plain) FormatClean(b []byte) template.HTML

Types

type HTML

type HTML struct{}

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

func (HTML) Format

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

Format returns save html.

func (HTML) FormatClean

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

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

type Markdown

type Markdown struct{}

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

func (Markdown) Format

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

Format returns a save html version of the Markdown input.

func (Markdown) FormatClean

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

type Plain struct{}

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

func (Plain) Format

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

Format returns a save html version of the input.

func (Plain) FormatClean

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

FormatClean returns a save html version of the input.