blackfriday

package module
v2.0.0-...-77691cd Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 11, 2016 License: BSD-2-Clause Imports: 8 Imported by: 0

README

Blackfriday Build Status

Blackfriday is a Markdown processor implemented in Go. It is paranoid about its input (so you can safely feed it user-supplied data), it is fast, it supports common extensions (tables, smart punctuation substitutions, etc.), and it is safe for all utf-8 (unicode) input.

HTML output is currently supported, along with Smartypants extensions. An experimental LaTeX output engine is also included.

It started as a translation from C of Sundown.

Installation

Blackfriday is compatible with Go 1. If you are using an older release of Go, consider using v1.1 of blackfriday, which was based on the last stable release of Go prior to Go 1. You can find it as a tagged commit on github.

With Go 1 and git installed:

go get github.com/russross/blackfriday

will download, compile, and install the package into your $GOPATH directory hierarchy. Alternatively, you can achieve the same if you import it into a project:

import "github.com/russross/blackfriday"

and go get without parameters.

Usage

For basic usage, it is as simple as getting your input into a byte slice and calling:

output := blackfriday.MarkdownBasic(input)

This renders it with no extensions enabled. To get a more useful feature set, use this instead:

output := blackfriday.MarkdownCommon(input)
Sanitize untrusted content

Blackfriday itself does nothing to protect against malicious content. If you are dealing with user-supplied markdown, we recommend running blackfriday's output through HTML sanitizer such as Bluemonday.

Here's an example of simple usage of blackfriday together with bluemonday:

import (
    "github.com/microcosm-cc/bluemonday"
    "github.com/russross/blackfriday"
)

// ...
unsafe := blackfriday.MarkdownCommon(input)
html := bluemonday.UGCPolicy().SanitizeBytes(unsafe)
Custom options

If you want to customize the set of options, first get a renderer (currently either the HTML or LaTeX output engines), then use it to call the more general Markdown function. For examples, see the implementations of MarkdownBasic and MarkdownCommon in markdown.go.

You can also check out blackfriday-tool for a more complete example of how to use it. Download and install it using:

go get github.com/russross/blackfriday-tool

This is a simple command-line tool that allows you to process a markdown file using a standalone program. You can also browse the source directly on github if you are just looking for some example code:

Note that if you have not already done so, installing blackfriday-tool will be sufficient to download and install blackfriday in addition to the tool itself. The tool binary will be installed in $GOPATH/bin. This is a statically-linked binary that can be copied to wherever you need it without worrying about dependencies and library versions.

Features

All features of Sundown are supported, including:

  • Compatibility. The Markdown v1.0.3 test suite passes with the --tidy option. Without --tidy, the differences are mostly in whitespace and entity escaping, where blackfriday is more consistent and cleaner.

  • Common extensions, including table support, fenced code blocks, autolinks, strikethroughs, non-strict emphasis, etc.

  • Safety. Blackfriday is paranoid when parsing, making it safe to feed untrusted user input without fear of bad things happening. The test suite stress tests this and there are no known inputs that make it crash. If you find one, please let me know and send me the input that does it.

    NOTE: "safety" in this context means runtime safety only. In order to protect yourself agains JavaScript injection in untrusted content, see this example.

  • Fast processing. It is fast enough to render on-demand in most web applications without having to cache the output.

  • Thread safety. You can run multiple parsers in different goroutines without ill effect. There is no dependence on global shared state.

  • Minimal dependencies. Blackfriday only depends on standard library packages in Go. The source code is pretty self-contained, so it is easy to add to any project, including Google App Engine projects.

  • Standards compliant. Output successfully validates using the W3C validation tool for HTML 4.01 and XHTML 1.0 Transitional.

Extensions

In addition to the standard markdown syntax, this package implements the following extensions:

  • Intra-word emphasis supression. The _ character is commonly used inside words when discussing code, so having markdown interpret it as an emphasis command is usually the wrong thing. Blackfriday lets you treat all emphasis markers as normal characters when they occur inside a word.

  • Tables. Tables can be created by drawing them in the input using a simple syntax:

    Name    | Age
--------|------
Bob     | 27
Alice   | 23

  • Fenced code blocks. In addition to the normal 4-space indentation to mark code blocks, you can explicitly mark them and supply a language (to make syntax highlighting simple). Just mark it like this:

    ``` go
func getTrue() bool {
    return true
}
```

    You can use 3 or more backticks to mark the beginning of the block, and the same number to mark the end of the block.

  • Definition lists. A simple definition list is made of a single-line term followed by a colon and the definition for that term.

    Cat
: Fluffy animal everyone likes

Internet
: Vector of transmission for pictures of cats

    Terms must be separated from the previous definition by a blank line.

  • Footnotes. A marker in the text that will become a superscript number; a footnote definition that will be placed in a list of footnotes at the end of the document. A footnote looks like this:

    This is a footnote.[^1]

[^1]: the footnote text.

  • Autolinking. Blackfriday can find URLs that have not been explicitly marked as links and turn them into links.

  • Strikethrough. Use two tildes (~~) to mark text that should be crossed out.

  • Hard line breaks. With this extension enabled (it is off by default in the MarkdownBasic and MarkdownCommon convenience functions), newlines in the input translate into line breaks in the output.

  • Smart quotes. Smartypants-style punctuation substitution is supported, turning normal double- and single-quote marks into curly quotes, etc.

  • LaTeX-style dash parsing is an additional option, where -- is translated into –, and --- is translated into —. This differs from most smartypants processors, which turn a single hyphen into an ndash and a double hyphen into an mdash.

  • Smart fractions, where anything that looks like a fraction is translated into suitable HTML (instead of just a few special cases like most smartypant processors). For example, 4/5 becomes <sup>4</sup>&frasl;<sub>5</sub>, which renders as 4⁄5.

Other renderers

Blackfriday is structured to allow alternative rendering engines. Here are a few of note:

  • github_flavored_markdown: provides a GitHub Flavored Markdown renderer with fenced code block highlighting, clickable header anchor links.

    It's not customizable, and its goal is to produce HTML output equivalent to the GitHub Markdown API endpoint, except the rendering is performed locally.

  • markdownfmt: like gofmt, but for markdown.

  • LaTeX output: renders output as LaTeX. This is currently part of the main Blackfriday repository, but may be split into its own project in the future. If you are interested in owning and maintaining the LaTeX output component, please be in touch.

    It renders some basic documents, but is only experimental at this point. In particular, it does not do any inline escaping, so input that happens to look like LaTeX code will be passed through without modification.

Todo

  • More unit testing
  • Improve unicode support. It does not understand all unicode rules (about what constitutes a letter, a punctuation symbol, etc.), so it may fail to detect word boundaries correctly in some instances. It is safe on all utf-8 input.

License

Blackfriday is distributed under the Simplified BSD License

Documentation

Overview

Blackfriday markdown processor.

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

Index

Constants

View Source 
const (
	Entity    = "&(?:#x[a-f0-9]{1,8}|#[0-9]{1,8}|[a-z][a-z0-9]{1,31});"
	Escapable = "[!\"#$%&'()*+,./:;<=>?@[\\\\\\]^_`{|}~-]"
)
View Source 
const (
	HtmlFlagsNone           HtmlFlags = 0
	SkipHTML                HtmlFlags = 1 << iota // Skip preformatted HTML blocks
	SkipStyle                                     // Skip embedded <style> elements
	SkipImages                                    // Skip embedded images
	SkipLinks                                     // Skip all links
	Safelink                                      // Only link to trusted protocols
	NofollowLinks                                 // Only link with rel="nofollow"
	NoreferrerLinks                               // Only link with rel="noreferrer"
	HrefTargetBlank                               // Add a blank target
	Toc                                           // Generate a table of contents
	OmitContents                                  // Skip the main contents (for a standalone table of contents)
	CompletePage                                  // Generate a complete HTML page
	UseXHTML                                      // Generate XHTML output instead of HTML
	UseSmartypants                                // Enable smart punctuation substitutions
	SmartypantsFractions                          // Enable smart fractions (with UseSmartypants)
	SmartypantsDashes                             // Enable smart dashes (with UseSmartypants)
	SmartypantsLatexDashes                        // Enable LaTeX-style dashes (with UseSmartypants)
	SmartypantsAngledQuotes                       // Enable angled double quotes (with UseSmartypants) for double quotes rendering
	FootnoteReturnLinks                           // Generate a link at the end of a footnote to return to the source

	TagName               = "[A-Za-z][A-Za-z0-9-]*"
	AttributeName         = "[a-zA-Z_:][a-zA-Z0-9:._-]*"
	UnquotedValue         = "[^\"'=<>`\\x00-\\x20]+"
	SingleQuotedValue     = "'[^']*'"
	DoubleQuotedValue     = "\"[^\"]*\""
	AttributeValue        = "(?:" + UnquotedValue + "|" + SingleQuotedValue + "|" + DoubleQuotedValue + ")"
	AttributeValueSpec    = "(?:" + "\\s*=" + "\\s*" + AttributeValue + ")"
	Attribute             = "(?:" + "\\s+" + AttributeName + AttributeValueSpec + "?)"
	OpenTag               = "<" + TagName + Attribute + "*" + "\\s*/?>"
	CloseTag              = "</" + TagName + "\\s*[>]"
	HTMLComment           = "<!---->|<!--(?:-?[^>-])(?:-?[^-])*-->"
	ProcessingInstruction = "[<][?].*?[?][>]"
	Declaration           = "<![A-Z]+" + "\\s+[^>]*>"
	CDATA                 = "<!\\[CDATA\\[[\\s\\S]*?\\]\\]>"
	HTMLTag               = "(?:" + OpenTag + "|" + CloseTag + "|" + HTMLComment + "|" +
		ProcessingInstruction + "|" + Declaration + "|" + CDATA + ")"
)

Html renderer configuration options.

View Source 
const (
	TableAlignmentLeft = 1 << iota
	TableAlignmentRight
	TableAlignmentCenter = (TableAlignmentLeft | TableAlignmentRight)
)

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.

View Source 
const (
	TabSizeDefault = 4
	TabSizeDouble  = 8
)

The size of a tab stop.

View Source 
const VERSION = "1.4"

Variables

This section is empty.

Functions

func Markdown 

func Markdown(input []byte, renderer Renderer, extensions Extensions) []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 suppression

* Tables

* Fenced code blocks

* Autolinking

* Strikethrough support

* Strict header parsing

* Custom Header IDs

func MarkdownOptions 

func MarkdownOptions(input []byte, renderer Renderer, opts Options) []byte

MarkdownOptions is just like Markdown but takes additional options through the Options struct.

Types

type Extensions 

type Extensions int
const (
	NoExtensions           Extensions = 0
	NoIntraEmphasis        Extensions = 1 << iota // Ignore emphasis markers inside words
	Tables                                        // Render tables
	FencedCode                                    // Render fenced code blocks
	Autolink                                      // Detect embedded URLs that are not explicitly marked
	Strikethrough                                 // Strikethrough text using ~~test~~
	LaxHTMLBlocks                                 // Loosen up HTML block parsing rules
	SpaceHeaders                                  // Be strict about prefix header rules
	HardLineBreak                                 // Translate newlines into line breaks
	TabSizeEight                                  // Expand tabs to eight spaces instead of four
	Footnotes                                     // Pandoc-style footnotes
	NoEmptyLineBeforeBlock                        // No need to insert an empty line to start a (code, quote, ordered list, unordered list) block
	HeaderIDs                                     // specify header IDs  with {#id}
	Titleblock                                    // Titleblock ala pandoc
	AutoHeaderIDs                                 // Create the header ID from the text
	BackslashLineBreak                            // Translate trailing backslashes into line breaks
	DefinitionLists                               // Render definition lists

)

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

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 (r *Html) AutoLink(link []byte, kind LinkType)

func (*Html) BeginFootnotes 

func (r *Html) BeginFootnotes()

func (*Html) BeginHeader 

func (r *Html) BeginHeader(level int, id string)

func (*Html) BeginList 

func (r *Html) BeginList(flags ListType)

func (*Html) BeginParagraph 

func (r *Html) BeginParagraph()

func (*Html) BlockCode 

func (r *Html) BlockCode(text []byte, lang string)

func (*Html) BlockHtml 

func (r *Html) BlockHtml(text []byte)

func (*Html) BlockQuote 

func (r *Html) BlockQuote(text []byte)

func (*Html) CaptureWrites 

func (r *Html) CaptureWrites(processor func()) []byte

func (*Html) CodeSpan 

func (r *Html) CodeSpan(text []byte)

func (*Html) CopyWrites 

func (r *Html) CopyWrites(processor func()) []byte

func (*Html) DocumentFooter 

func (r *Html) DocumentFooter()

func (*Html) DocumentHeader 

func (r *Html) DocumentHeader()

func (*Html) DoubleEmphasis 

func (r *Html) DoubleEmphasis(text []byte)

func (*Html) Emphasis 

func (r *Html) Emphasis(text []byte)

func (*Html) EndFootnotes 

func (r *Html) EndFootnotes()

func (*Html) EndHeader 

func (r *Html) EndHeader(level int, id string, header []byte)

func (*Html) EndList 

func (r *Html) EndList(flags ListType)

func (*Html) EndParagraph 

func (r *Html) EndParagraph()

func (*Html) Entity 

func (r *Html) Entity(entity []byte)

func (*Html) FootnoteItem 

func (r *Html) FootnoteItem(name, text []byte, flags ListType)

func (*Html) FootnoteRef 

func (r *Html) FootnoteRef(ref []byte, id int)

func (*Html) GetAST 

func (r *Html) GetAST() *Node

func (*Html) GetFlags 

func (r *Html) GetFlags() HtmlFlags

func (*Html) GetResult 

func (r *Html) GetResult() []byte

func (*Html) HRule 

func (r *Html) HRule()

func (*Html) Image 

func (r *Html) Image(link []byte, title []byte, alt []byte)

func (*Html) LineBreak 

func (r *Html) LineBreak()
func (r *Html) Link(link []byte, title []byte, content []byte)

func (*Html) ListItem 

func (r *Html) ListItem(text []byte, flags ListType)

func (*Html) NormalText 

func (r *Html) NormalText(text []byte)

func (*Html) RawHtmlTag 

func (r *Html) RawHtmlTag(text []byte)

func (*Html) Render 

func (r *Html) Render(ast *Node) []byte

func (*Html) SetAST 

func (r *Html) SetAST(ast *Node)

func (*Html) Smartypants 

func (r *Html) Smartypants(text []byte)

func (*Html) Smartypants2 

func (r *Html) Smartypants2(text []byte) []byte

func (*Html) StrikeThrough 

func (r *Html) StrikeThrough(text []byte)

func (*Html) Table 

func (r *Html) Table(header []byte, body []byte, columnData []int)

func (*Html) TableCell 

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

func (*Html) TableHeaderCell 

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

func (*Html) TableRow 

func (r *Html) TableRow(text []byte)

func (*Html) TitleBlock 

func (r *Html) TitleBlock(text []byte)

func (*Html) TocFinalize 

func (r *Html) TocFinalize()

func (*Html) TocHeader 

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

func (*Html) TocHeaderWithAnchor 

func (r *Html) TocHeaderWithAnchor(text []byte, level int, anchor string)

func (*Html) TripleEmphasis 

func (r *Html) TripleEmphasis(text []byte)

func (*Html) Write 

func (r *Html) Write(b []byte) (int, error)

type HtmlFlags 

type HtmlFlags int

type HtmlRendererParameters 

type HtmlRendererParameters struct {
	// Prepend this text to each relative URL.
	AbsolutePrefix string
	// Add this text to each footnote anchor, to ensure uniqueness.
	FootnoteAnchorPrefix string
	// Show this text inside the <a> tag for a footnote return link, if the
	// HTML_FOOTNOTE_RETURN_LINKS flag is enabled. If blank, the string
	// <sup>[return]</sup> is used.
	FootnoteReturnLinkContents string
	// If set, add this text to the front of each Header ID, to ensure
	// uniqueness.
	HeaderIDPrefix string
	// If set, add this text to the back of each Header ID, to ensure uniqueness.
	HeaderIDSuffix string
}

type HtmlWriter 

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

func (*HtmlWriter) Newline 

func (w *HtmlWriter) Newline()

Writes out a newline if the output is not pristine. Used at the beginning of every rendering func

func (*HtmlWriter) Write 

func (w *HtmlWriter) Write(p []byte) (n int, err error)

func (*HtmlWriter) WriteByte 

func (w *HtmlWriter) WriteByte(b byte) error

func (*HtmlWriter) WriteString 

func (w *HtmlWriter) WriteString(s string) (n int, err error)

type Latex 

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

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

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

func (r *Latex) AutoLink(link []byte, kind LinkType)

func (*Latex) BeginFootnotes 

func (r *Latex) BeginFootnotes()

TODO: this

func (*Latex) BeginHeader 

func (r *Latex) BeginHeader(level int, id string)

func (*Latex) BeginList 

func (r *Latex) BeginList(flags ListType)

func (*Latex) BeginParagraph 

func (r *Latex) BeginParagraph()

func (*Latex) BlockCode 

func (r *Latex) BlockCode(text []byte, lang string)

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

func (*Latex) BlockHtml 

func (r *Latex) BlockHtml(text []byte)

func (*Latex) BlockQuote 

func (r *Latex) BlockQuote(text []byte)

func (*Latex) CaptureWrites 

func (r *Latex) CaptureWrites(processor func()) []byte

func (*Latex) CodeSpan 

func (r *Latex) CodeSpan(text []byte)

func (*Latex) CopyWrites 

func (r *Latex) CopyWrites(processor func()) []byte

func (*Latex) DocumentFooter 

func (r *Latex) DocumentFooter()

func (*Latex) DocumentHeader 

func (r *Latex) DocumentHeader()

header and footer

func (*Latex) DoubleEmphasis 

func (r *Latex) DoubleEmphasis(text []byte)

func (*Latex) Emphasis 

func (r *Latex) Emphasis(text []byte)

func (*Latex) EndFootnotes 

func (r *Latex) EndFootnotes()

TODO: this

func (*Latex) EndHeader 

func (r *Latex) EndHeader(level int, id string, header []byte)

func (*Latex) EndList 

func (r *Latex) EndList(flags ListType)

func (*Latex) EndParagraph 

func (r *Latex) EndParagraph()

func (*Latex) Entity 

func (r *Latex) Entity(entity []byte)

func (*Latex) FootnoteItem 

func (r *Latex) FootnoteItem(name, text []byte, flags ListType)

func (*Latex) FootnoteRef 

func (r *Latex) FootnoteRef(ref []byte, id int)

TODO: this

func (*Latex) GetAST 

func (r *Latex) GetAST() *Node

func (*Latex) GetFlags 

func (r *Latex) GetFlags() HtmlFlags

func (*Latex) GetResult 

func (r *Latex) GetResult() []byte

func (*Latex) HRule 

func (r *Latex) HRule()

func (*Latex) Image 

func (r *Latex) Image(link []byte, title []byte, alt []byte)

func (*Latex) LineBreak 

func (r *Latex) LineBreak()
func (r *Latex) Link(link []byte, title []byte, content []byte)

func (*Latex) ListItem 

func (r *Latex) ListItem(text []byte, flags ListType)

func (*Latex) NormalText 

func (r *Latex) NormalText(text []byte)

func (*Latex) RawHtmlTag 

func (r *Latex) RawHtmlTag(tag []byte)

func (*Latex) Render 

func (r *Latex) Render(ast *Node) []byte

func (*Latex) SetAST 

func (r *Latex) SetAST(ast *Node)

func (*Latex) StrikeThrough 

func (r *Latex) StrikeThrough(text []byte)

func (*Latex) Table 

func (r *Latex) Table(header []byte, body []byte, columnData []int)

func (*Latex) TableCell 

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

func (*Latex) TableHeaderCell 

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

func (*Latex) TableRow 

func (r *Latex) TableRow(text []byte)

func (*Latex) TitleBlock 

func (r *Latex) TitleBlock(text []byte)

func (*Latex) TripleEmphasis 

func (r *Latex) TripleEmphasis(text []byte)

func (*Latex) Write 

func (r *Latex) Write(b []byte) (int, error)

type LinkData 

type LinkData struct {
	Destination []byte
	Title       []byte
	NoteID      int
}

type LinkType 

type LinkType int
const (
	LinkTypeNotAutolink LinkType = iota
	LinkTypeNormal
	LinkTypeEmail
)

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.

type ListData 

type ListData struct {
	Flags ListType
	// contains filtered or unexported fields
}

type ListType 

type ListType int
const (
	ListTypeOrdered ListType = 1 << iota
	ListTypeDefinition
	ListTypeTerm

	ListItemContainsBlock
	ListItemBeginningOfList
	ListItemEndOfList
)

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.

type Node 

type Node struct {
	Type NodeType

	LinkData            // If Type == Link, this holds link info
	HeaderID     string // If Type == Header, this might hold header ID, if present
	IsTitleblock bool
	IsHeader     bool // If Type == TableCell, this tells if it's under the header row

	// TODO: convert the int to a proper type
	Align int // If Type == TableCell, this holds the value for align attribute
	// contains filtered or unexported fields
}

func NewNode 

func NewNode(typ NodeType) *Node

type NodeType 

type NodeType int
const (
	Document NodeType = iota
	BlockQuote
	List
	Item
	Paragraph
	Header
	HorizontalRule
	Emph
	Strong
	Del
	Link
	Image
	Text
	HtmlBlock
	CodeBlock
	Softbreak
	Hardbreak
	Code
	HtmlSpan
	Table
	TableCell
	TableHead
	TableBody
	TableRow
)

func (NodeType) String 

func (t NodeType) String() string

type NodeWalker 

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

func NewNodeWalker 

func NewNodeWalker(root *Node) *NodeWalker

type Options 

type Options struct {
	// Extensions is a flag set of bit-wise ORed extension bits. See the
	// Extensions flags defined in this package.
	Extensions Extensions

	// ReferenceOverride is an optional function callback that is called every
	// time a reference is resolved.
	//
	// In Markdown, the link reference syntax can be made to resolve a link to
	// a reference instead of an inline URL, in one of the following ways:
	//
	//  * [link text][refid]
	//  * [refid][]
	//
	// Usually, the refid is defined at the bottom of the Markdown document. If
	// this override function is provided, the refid is passed to the override
	// function first, before consulting the defined refids at the bottom. If
	// the override function indicates an override did not occur, the refids at
	// the bottom will be used to fill in the link details.
	ReferenceOverride ReferenceOverrideFunc
}

Options represents configurable overrides and callbacks (in addition to the extension flag set) for configuring a Markdown parse.

type Reference 

type Reference struct {
	// Link is usually the URL the reference points to.
	Link string
	// Title is the alternate text describing the link in more detail.
	Title string
	// Text is the optional text to override the ref with if the syntax used was
	// [refid][]
	Text string
}

Reference represents the details of a link. See the documentation in Options for more details on use-case.

type ReferenceOverrideFunc 

type ReferenceOverrideFunc func(reference string) (ref *Reference, overridden bool)

ReferenceOverrideFunc is expected to be called with a reference string and return either a valid Reference type that the reference string maps to or nil. If overridden is false, the default reference logic will be executed. See the documentation in Options for more details on use-case.

type Renderer 

type Renderer interface {
	// block-level callbacks
	BlockCode(text []byte, lang string)
	BlockQuote(text []byte)
	BlockHtml(text []byte)
	BeginHeader(level int, id string)
	EndHeader(level int, id string, header []byte)
	HRule()
	BeginList(flags ListType)
	EndList(flags ListType)
	ListItem(text []byte, flags ListType)
	BeginParagraph()
	EndParagraph()
	Table(header []byte, body []byte, columnData []int)
	TableRow(text []byte)
	TableHeaderCell(out *bytes.Buffer, text []byte, flags int)
	TableCell(out *bytes.Buffer, text []byte, flags int)
	BeginFootnotes()
	EndFootnotes()
	FootnoteItem(name, text []byte, flags ListType)
	TitleBlock(text []byte)

	// Span-level callbacks
	AutoLink(link []byte, kind LinkType)
	CodeSpan(text []byte)
	DoubleEmphasis(text []byte)
	Emphasis(text []byte)
	Image(link []byte, title []byte, alt []byte)
	LineBreak()
	Link(link []byte, title []byte, content []byte)
	RawHtmlTag(tag []byte)
	TripleEmphasis(text []byte)
	StrikeThrough(text []byte)
	FootnoteRef(ref []byte, id int)

	// Low-level callbacks
	Entity(entity []byte)
	NormalText(text []byte)

	// Header and footer
	DocumentHeader()
	DocumentFooter()

	GetFlags() HtmlFlags
	CaptureWrites(processor func()) []byte
	CopyWrites(processor func()) []byte
	Write(b []byte) (int, error)
	GetResult() []byte

	SetAST(ast *Node)
	GetAST() *Node

	Render(ast *Node) []byte
}

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 HtmlFlags, title string, css string) Renderer

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

flags is a set of HtmlFlags 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 HtmlRendererWithParameters 

func HtmlRendererWithParameters(flags HtmlFlags, title string,
	css string, renderParameters HtmlRendererParameters) Renderer

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).

type TableFlags 

type TableFlags int

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.