Package blackfriday

import "github.com/BurntSushi/blackfriday"
Overview
Index

Overview ▾

Blackfriday markdown processor.

Translates plain text with simple formatting rules into HTML or LaTeX.

Index ▾

Constants
func Markdown(input []byte, renderer Renderer, extensions int) []byte
func MarkdownBasic(input []byte) []byte
func MarkdownCommon(input []byte) []byte
type Html
    func (options *Html) AutoLink(out *bytes.Buffer, link []byte, kind int)
    func (options *Html) BlockCode(out *bytes.Buffer, text []byte, lang string)
    func (options *Html) BlockCodeGithub(out *bytes.Buffer, text []byte, lang string)
    func (options *Html) BlockCodeNormal(out *bytes.Buffer, text []byte, lang string)
    func (options *Html) BlockHtml(out *bytes.Buffer, text []byte)
    func (options *Html) BlockQuote(out *bytes.Buffer, text []byte)
    func (options *Html) CodeSpan(out *bytes.Buffer, text []byte)
    func (options *Html) DocumentFooter(out *bytes.Buffer)
    func (options *Html) DocumentHeader(out *bytes.Buffer)
    func (options *Html) DoubleEmphasis(out *bytes.Buffer, text []byte)
    func (options *Html) Emphasis(out *bytes.Buffer, text []byte)
    func (options *Html) Entity(out *bytes.Buffer, entity []byte)
    func (options *Html) HRule(out *bytes.Buffer)
    func (options *Html) Header(out *bytes.Buffer, text func() bool, level int)
    func (options *Html) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)
    func (options *Html) LineBreak(out *bytes.Buffer)
    func (options *Html) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)
    func (options *Html) List(out *bytes.Buffer, text func() bool, flags int)
    func (options *Html) ListItem(out *bytes.Buffer, text []byte, flags int)
    func (options *Html) NormalText(out *bytes.Buffer, text []byte)
    func (options *Html) Paragraph(out *bytes.Buffer, text func() bool)
    func (options *Html) RawHtmlTag(out *bytes.Buffer, text []byte)
    func (options *Html) Smartypants(out *bytes.Buffer, text []byte)
    func (options *Html) StrikeThrough(out *bytes.Buffer, text []byte)
    func (options *Html) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int)
    func (options *Html) TableCell(out *bytes.Buffer, text []byte, align int)
    func (options *Html) TableRow(out *bytes.Buffer, text []byte)
    func (options *Html) TocFinalize()
    func (options *Html) TocHeader(text []byte, level int)
    func (options *Html) TripleEmphasis(out *bytes.Buffer, text []byte)
type Latex
    func (options *Latex) AutoLink(out *bytes.Buffer, link []byte, kind int)
    func (options *Latex) BlockCode(out *bytes.Buffer, text []byte, lang string)
    func (options *Latex) BlockHtml(out *bytes.Buffer, text []byte)
    func (options *Latex) BlockQuote(out *bytes.Buffer, text []byte)
    func (options *Latex) CodeSpan(out *bytes.Buffer, text []byte)
    func (options *Latex) DocumentFooter(out *bytes.Buffer)
    func (options *Latex) DocumentHeader(out *bytes.Buffer)
    func (options *Latex) DoubleEmphasis(out *bytes.Buffer, text []byte)
    func (options *Latex) Emphasis(out *bytes.Buffer, text []byte)
    func (options *Latex) Entity(out *bytes.Buffer, entity []byte)
    func (options *Latex) HRule(out *bytes.Buffer)
    func (options *Latex) Header(out *bytes.Buffer, text func() bool, level int)
    func (options *Latex) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)
    func (options *Latex) LineBreak(out *bytes.Buffer)
    func (options *Latex) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)
    func (options *Latex) List(out *bytes.Buffer, text func() bool, flags int)
    func (options *Latex) ListItem(out *bytes.Buffer, text []byte, flags int)
    func (options *Latex) NormalText(out *bytes.Buffer, text []byte)
    func (options *Latex) Paragraph(out *bytes.Buffer, text func() bool)
    func (options *Latex) RawHtmlTag(out *bytes.Buffer, tag []byte)
    func (options *Latex) StrikeThrough(out *bytes.Buffer, text []byte)
    func (options *Latex) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int)
    func (options *Latex) TableCell(out *bytes.Buffer, text []byte, align int)
    func (options *Latex) TableRow(out *bytes.Buffer, text []byte)
    func (options *Latex) TripleEmphasis(out *bytes.Buffer, text []byte)
type Renderer
    func HtmlRenderer(flags int, title string, css string) Renderer
    func LatexRenderer(flags int) Renderer

Package files

block.go html.go inline.go latex.go markdown.go smartypants.go

Constants

const (
    HTML_SKIP_HTML                = 1 << iota // skip preformatted HTML blocks
    HTML_SKIP_STYLE                           // skip embedded <style> elements
    HTML_SKIP_IMAGES                          // skip embedded images
    HTML_SKIP_LINKS                           // skip all links
    HTML_SKIP_ESCAPE                          // skips escaping; useful when everything is escaped before
    HTML_SAFELINK                             // only link to trusted protocols
    HTML_TOC                                  // generate a table of contents
    HTML_OMIT_CONTENTS                        // skip the main contents (for a standalone table of contents)
    HTML_COMPLETE_PAGE                        // generate a complete HTML page
    HTML_GITHUB_BLOCKCODE                     // use github fenced code rendering rules
    HTML_USE_XHTML                            // generate XHTML output instead of HTML
    HTML_USE_SMARTYPANTS                      // enable smart punctuation substitutions
    HTML_SMARTYPANTS_FRACTIONS                // enable smart fractions (with HTML_USE_SMARTYPANTS)
    HTML_SMARTYPANTS_LATEX_DASHES             // enable LaTeX-style dashes (with HTML_USE_SMARTYPANTS)
)

Html renderer configuration options.

const (
    EXTENSION_NO_INTRA_EMPHASIS = 1 << iota // ignore emphasis markers inside words
    EXTENSION_TABLES                        // render tables
    EXTENSION_FENCED_CODE                   // render fenced code blocks
    EXTENSION_AUTOLINK                      // detect embedded URLs that are not explicitly marked
    EXTENSION_STRIKETHROUGH                 // strikethrough text using ~~test~~
    EXTENSION_LAX_HTML_BLOCKS               // loosen up HTML block parsing rules
    EXTENSION_SPACE_HEADERS                 // be strict about prefix header rules
    EXTENSION_HARD_LINE_BREAK               // translate newlines into line breaks
    EXTENSION_TAB_SIZE_EIGHT                // expand tabs to eight spaces instead of four
)

These are the supported markdown parsing extensions. OR these values together to select multiple extensions.

const (
    LINK_TYPE_NOT_AUTOLINK = iota
    LINK_TYPE_NORMAL
    LINK_TYPE_EMAIL
)

These are the possible flag values for the link renderer. Only a single one of these values will be used; they are not ORed together. These are mostly of interest if you are writing a new output format.

const (
    LIST_TYPE_ORDERED = 1 << iota
    LIST_ITEM_CONTAINS_BLOCK
    LIST_ITEM_BEGINNING_OF_LIST
    LIST_ITEM_END_OF_LIST
)

These are the possible flag values for the ListItem renderer. Multiple flag values may be ORed together. These are mostly of interest if you are writing a new output format.

const (
    TABLE_ALIGNMENT_LEFT = 1 << iota
    TABLE_ALIGNMENT_RIGHT
    TABLE_ALIGNMENT_CENTER = (TABLE_ALIGNMENT_LEFT | TABLE_ALIGNMENT_RIGHT)
)

These are the possible flag values for the table cell renderer. Only a single one of these values will be used; they are not ORed together. These are mostly of interest if you are writing a new output format.

const (
    TAB_SIZE_DEFAULT = 4
    TAB_SIZE_EIGHT   = 8
)

The size of a tab stop.

const VERSION = "1.1"

func Markdown

func Markdown(input []byte, renderer Renderer, extensions int) []byte

Markdown is the main rendering function. It parses and renders a block of markdown-encoded text. The supplied Renderer is used to format the output, and extensions dictates which non-standard extensions are enabled.

To use the supplied Html or LaTeX renderers, see HtmlRenderer and LatexRenderer, respectively.

func MarkdownBasic

func MarkdownBasic(input []byte) []byte

MarkdownBasic is a convenience function for simple rendering. It processes markdown input with no extensions enabled.

func MarkdownCommon

func MarkdownCommon(input []byte) []byte

Call Markdown with most useful extensions enabled MarkdownCommon is a convenience function for simple rendering. It processes markdown input with common extensions enabled, including:

* Smartypants processing with smart fractions and LaTeX dashes

* Intra-word emphasis supression

* Tables

* Fenced code blocks

* Autolinking

* Strikethrough support

* Strict header parsing

type Html

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

Html is a type that implements the Renderer interface for HTML output.

Do not create this directly, instead use the HtmlRenderer function.

func (options *Html) AutoLink(out *bytes.Buffer, link []byte, kind int)

func (*Html) BlockCode

func (options *Html) BlockCode(out *bytes.Buffer, text []byte, lang string)

func (*Html) BlockCodeGithub

func (options *Html) BlockCodeGithub(out *bytes.Buffer, text []byte, lang string)

* GitHub style code block: * * <pre lang="LANG"><code> * ... * </pre></code> * * Unlike other parsers, we store the language identifier in the <pre>, * and don't let the user generate custom classes. * * The language identifier in the <pre> block gets postprocessed and all * the code inside gets syntax highlighted with Pygments. This is much safer * than letting the user specify a CSS class for highlighting. * * Note that we only generate HTML for the first specifier. * E.g. * ~~~~ {.python .numbered} => <pre lang="python"><code>

func (*Html) BlockCodeNormal

func (options *Html) BlockCodeNormal(out *bytes.Buffer, text []byte, lang string)

func (*Html) BlockHtml

func (options *Html) BlockHtml(out *bytes.Buffer, text []byte)

func (*Html) BlockQuote

func (options *Html) BlockQuote(out *bytes.Buffer, text []byte)

func (*Html) CodeSpan

func (options *Html) CodeSpan(out *bytes.Buffer, text []byte)

func (*Html) DocumentFooter

func (options *Html) DocumentFooter(out *bytes.Buffer)

func (*Html) DocumentHeader

func (options *Html) DocumentHeader(out *bytes.Buffer)

func (*Html) DoubleEmphasis

func (options *Html) DoubleEmphasis(out *bytes.Buffer, text []byte)

func (*Html) Emphasis

func (options *Html) Emphasis(out *bytes.Buffer, text []byte)

func (*Html) Entity

func (options *Html) Entity(out *bytes.Buffer, entity []byte)

func (*Html) HRule

func (options *Html) HRule(out *bytes.Buffer)

func (*Html) Header

func (options *Html) Header(out *bytes.Buffer, text func() bool, level int)

func (*Html) Image

func (options *Html) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)

func (*Html) LineBreak

func (options *Html) LineBreak(out *bytes.Buffer)
func (options *Html) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)

func (*Html) List

func (options *Html) List(out *bytes.Buffer, text func() bool, flags int)

func (*Html) ListItem

func (options *Html) ListItem(out *bytes.Buffer, text []byte, flags int)

func (*Html) NormalText

func (options *Html) NormalText(out *bytes.Buffer, text []byte)

func (*Html) Paragraph

func (options *Html) Paragraph(out *bytes.Buffer, text func() bool)

func (*Html) RawHtmlTag

func (options *Html) RawHtmlTag(out *bytes.Buffer, text []byte)

func (*Html) Smartypants

func (options *Html) Smartypants(out *bytes.Buffer, text []byte)

func (*Html) StrikeThrough

func (options *Html) StrikeThrough(out *bytes.Buffer, text []byte)

func (*Html) Table

func (options *Html) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int)

func (*Html) TableCell

func (options *Html) TableCell(out *bytes.Buffer, text []byte, align int)

func (*Html) TableRow

func (options *Html) TableRow(out *bytes.Buffer, text []byte)

func (*Html) TocFinalize

func (options *Html) TocFinalize()

func (*Html) TocHeader

func (options *Html) TocHeader(text []byte, level int)

func (*Html) TripleEmphasis

func (options *Html) TripleEmphasis(out *bytes.Buffer, text []byte)

type Latex

type Latex struct {
}

Latex is a type that implements the Renderer interface for LaTeX output.

Do not create this directly, instead use the LatexRenderer function.

func (options *Latex) AutoLink(out *bytes.Buffer, link []byte, kind int)

func (*Latex) BlockCode

func (options *Latex) BlockCode(out *bytes.Buffer, text []byte, lang string)

render code chunks using verbatim, or listings if we have a language

func (*Latex) BlockHtml

func (options *Latex) BlockHtml(out *bytes.Buffer, text []byte)

func (*Latex) BlockQuote

func (options *Latex) BlockQuote(out *bytes.Buffer, text []byte)

func (*Latex) CodeSpan

func (options *Latex) CodeSpan(out *bytes.Buffer, text []byte)

func (*Latex) DocumentFooter

func (options *Latex) DocumentFooter(out *bytes.Buffer)

func (*Latex) DocumentHeader

func (options *Latex) DocumentHeader(out *bytes.Buffer)

header and footer

func (*Latex) DoubleEmphasis

func (options *Latex) DoubleEmphasis(out *bytes.Buffer, text []byte)

func (*Latex) Emphasis

func (options *Latex) Emphasis(out *bytes.Buffer, text []byte)

func (*Latex) Entity

func (options *Latex) Entity(out *bytes.Buffer, entity []byte)

func (*Latex) HRule

func (options *Latex) HRule(out *bytes.Buffer)

func (*Latex) Header

func (options *Latex) Header(out *bytes.Buffer, text func() bool, level int)

func (*Latex) Image

func (options *Latex) Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)

func (*Latex) LineBreak

func (options *Latex) LineBreak(out *bytes.Buffer)
func (options *Latex) Link(out *bytes.Buffer, link []byte, title []byte, content []byte)

func (*Latex) List

func (options *Latex) List(out *bytes.Buffer, text func() bool, flags int)

func (*Latex) ListItem

func (options *Latex) ListItem(out *bytes.Buffer, text []byte, flags int)

func (*Latex) NormalText

func (options *Latex) NormalText(out *bytes.Buffer, text []byte)

func (*Latex) Paragraph

func (options *Latex) Paragraph(out *bytes.Buffer, text func() bool)

func (*Latex) RawHtmlTag

func (options *Latex) RawHtmlTag(out *bytes.Buffer, tag []byte)

func (*Latex) StrikeThrough

func (options *Latex) StrikeThrough(out *bytes.Buffer, text []byte)

func (*Latex) Table

func (options *Latex) Table(out *bytes.Buffer, header []byte, body []byte, columnData []int)

func (*Latex) TableCell

func (options *Latex) TableCell(out *bytes.Buffer, text []byte, align int)

func (*Latex) TableRow

func (options *Latex) TableRow(out *bytes.Buffer, text []byte)

func (*Latex) TripleEmphasis

func (options *Latex) TripleEmphasis(out *bytes.Buffer, text []byte)

type Renderer

type Renderer interface {
    // block-level callbacks
    BlockCode(out *bytes.Buffer, text []byte, lang string)
    BlockQuote(out *bytes.Buffer, text []byte)
    BlockHtml(out *bytes.Buffer, text []byte)
    Header(out *bytes.Buffer, text func() bool, level int)
    HRule(out *bytes.Buffer)
    List(out *bytes.Buffer, text func() bool, flags int)
    ListItem(out *bytes.Buffer, text []byte, flags int)
    Paragraph(out *bytes.Buffer, text func() bool)
    Table(out *bytes.Buffer, header []byte, body []byte, columnData []int)
    TableRow(out *bytes.Buffer, text []byte)
    TableCell(out *bytes.Buffer, text []byte, flags int)

    // Span-level callbacks
    AutoLink(out *bytes.Buffer, link []byte, kind int)
    CodeSpan(out *bytes.Buffer, text []byte)
    DoubleEmphasis(out *bytes.Buffer, text []byte)
    Emphasis(out *bytes.Buffer, text []byte)
    Image(out *bytes.Buffer, link []byte, title []byte, alt []byte)
    LineBreak(out *bytes.Buffer)
    Link(out *bytes.Buffer, link []byte, title []byte, content []byte)
    RawHtmlTag(out *bytes.Buffer, tag []byte)
    TripleEmphasis(out *bytes.Buffer, text []byte)
    StrikeThrough(out *bytes.Buffer, text []byte)

    // Low-level callbacks
    Entity(out *bytes.Buffer, entity []byte)
    NormalText(out *bytes.Buffer, text []byte)

    // Header and footer
    DocumentHeader(out *bytes.Buffer)
    DocumentFooter(out *bytes.Buffer)
}

Renderer is the rendering interface. This is mostly of interest if you are implementing a new rendering format.

When a byte slice is provided, it contains the (rendered) contents of the element.

When a callback is provided instead, it will write the contents of the respective element directly to the output buffer and return true on success. If the callback returns false, the rendering function should reset the output buffer as though it had never been called.

Currently Html and Latex implementations are provided

func HtmlRenderer

func HtmlRenderer(flags int, title string, css string) Renderer

HtmlRenderer creates and configures an Html object, which satisfies the Renderer interface.

flags is a set of HTML_* options ORed together. title is the title of the document, and css is a URL for the document's stylesheet. title and css are only used when HTML_COMPLETE_PAGE is selected.

func LatexRenderer

func LatexRenderer(flags int) Renderer

LatexRenderer creates and configures a Latex object, which satisfies the Renderer interface.

flags is a set of LATEX_* options ORed together (currently no such options are defined).