markdown

Documentation

Overview

Package markdown provides Markdown utilities.

Index

• func TemplateHTML(md string, fixCarets bool) template.HTML

Functions

func TemplateHTML

func TemplateHTML(md string, fixCarets bool) template.HTML

TemplateHTML renders Markdown into template.HTML suitable for use in cmd/server. Embedded Markdown in Go code blocks is typically quoted using back quotes ("`") which are used within Markdown for fixed font markup.

The fixCarets flag will change every caret character ("^") in the provided string to a back quote ("`") prior to parsing the Markdown text, allowing carets to be used for fixed font markup instead of back quotes. Set fixCarets to true for use with back quoted strings with carets, false for use with embedded Markdown files containing back quotes.