markdown

Documentation

Index

• func ToHTML(src string, style Style) template.HTML
• type NoEscapeCodeBlockRenderer
  • func NewNoEscapeCodeBlockRenderer() *NoEscapeCodeBlockRenderer
  • func (r *NoEscapeCodeBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type Style

Functions

func ToHTML

func ToHTML(src string, style Style) template.HTML

Types

type NoEscapeCodeBlockRenderer

type NoEscapeCodeBlockRenderer struct {
	html.Config
}

NoEscapeCodeBlockRenderer is a renderer.NodeRenderer implementation that renders code blocks without escaping HTML special characters.

This is needed in lintian-ssg because the tag description are not really Markdown conformant. They are over-escaped inside code blocks, which means that another pass of escaping will not produce the expected result.

Specifically, Lintian tags explanation have had their underscores (_) replaced by _ in lintian#d590cbf22, as well as some other special chars, apparently to fix the HTML output. Escaping them once more, as the default CodeBlock renderer would do it, would result in _ being displayed in the code block instead of the expected underscore (_).

This renderer could be removed once the tag descriptions are fixed to use conformant Markdown.

func NewNoEscapeCodeBlockRenderer

func NewNoEscapeCodeBlockRenderer() *NoEscapeCodeBlockRenderer

NewNoEscapeCodeBlockRenderer returns a new NoEscapeCodeBlockRenderer.

func (*NoEscapeCodeBlockRenderer) RegisterFuncs

func (r *NoEscapeCodeBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.

type Style

type Style int

const (
	StyleInline Style = iota
	StyleFull
)