Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

blackfriday

package module

Go to main page

Versions in this module

v1

v1.5.1

Feb 18, 2018

Changes in this version

+ const EXTENSION_AUTOLINK

+ const EXTENSION_AUTO_HEADER_IDS

+ const EXTENSION_BACKSLASH_LINE_BREAK

+ const EXTENSION_DEFINITION_LISTS

+ const EXTENSION_FENCED_CODE

+ const EXTENSION_FOOTNOTES

+ const EXTENSION_HARD_LINE_BREAK

+ const EXTENSION_HEADER_IDS

+ const EXTENSION_JOIN_LINES

+ const EXTENSION_LAX_HTML_BLOCKS

+ const EXTENSION_NO_EMPTY_LINE_BEFORE_BLOCK

+ const EXTENSION_NO_INTRA_EMPHASIS

+ const EXTENSION_SPACE_HEADERS

+ const EXTENSION_STRIKETHROUGH

+ const EXTENSION_TABLES

+ const EXTENSION_TAB_SIZE_EIGHT

+ const EXTENSION_TITLEBLOCK

+ const HTML_COMPLETE_PAGE

+ const HTML_FOOTNOTE_RETURN_LINKS

+ const HTML_HREF_TARGET_BLANK

+ const HTML_NOFOLLOW_LINKS

+ const HTML_NOREFERRER_LINKS

+ const HTML_OMIT_CONTENTS

+ const HTML_SAFELINK

+ const HTML_SKIP_HTML

+ const HTML_SKIP_IMAGES

+ const HTML_SKIP_LINKS

+ const HTML_SKIP_STYLE

+ const HTML_SMARTYPANTS_ANGLED_QUOTES

+ const HTML_SMARTYPANTS_DASHES

+ const HTML_SMARTYPANTS_FRACTIONS

+ const HTML_SMARTYPANTS_LATEX_DASHES

+ const HTML_SMARTYPANTS_QUOTES_NBSP

+ const HTML_TOC

+ const HTML_USE_SMARTYPANTS

+ const HTML_USE_XHTML

+ const LINK_TYPE_EMAIL

+ const LINK_TYPE_NORMAL

+ const LINK_TYPE_NOT_AUTOLINK

+ const LIST_ITEM_BEGINNING_OF_LIST

+ const LIST_ITEM_CONTAINS_BLOCK

+ const LIST_ITEM_END_OF_LIST

+ const LIST_TYPE_DEFINITION

+ const LIST_TYPE_ORDERED

+ const LIST_TYPE_TERM

+ const TABLE_ALIGNMENT_CENTER

+ const TABLE_ALIGNMENT_LEFT

+ const TABLE_ALIGNMENT_RIGHT

+ const TAB_SIZE_DEFAULT

+ const TAB_SIZE_EIGHT

+ const VERSION

+ func MarkdownBasic(input []byte) []byte

+ func MarkdownCommon(input []byte) []byte

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

+ type Html struct

+ 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) 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) FootnoteItem(out *bytes.Buffer, name, text []byte, flags int)

+ func (options *Html) FootnoteRef(out *bytes.Buffer, ref []byte, id int)

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

+ func (options *Html) GetFlags() int

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

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

+ 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) TableHeaderCell(out *bytes.Buffer, text []byte, align int)

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

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

+ func (options *Html) TocFinalize()

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

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

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

+ type HtmlRendererParameters struct

+ AbsolutePrefix string

+ FootnoteAnchorPrefix string

+ FootnoteReturnLinkContents string

+ HeaderIDPrefix string

+ HeaderIDSuffix string

+ type Latex struct

+ 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) FootnoteItem(out *bytes.Buffer, name, text []byte, flags int)

+ func (options *Latex) FootnoteRef(out *bytes.Buffer, ref []byte, id int)

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

+ func (options *Latex) GetFlags() int

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

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

+ 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) TableHeaderCell(out *bytes.Buffer, text []byte, align int)

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

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

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

+ type Options struct

+ Extensions int

+ ReferenceOverride ReferenceOverrideFunc

type Renderer

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

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

+ func LatexRenderer(flags int) Renderer

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

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

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

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

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

+ DocumentFooter func(out *bytes.Buffer)

+ DocumentHeader func(out *bytes.Buffer)

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

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

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

+ FootnoteItem func(out *bytes.Buffer, name, text []byte, flags int)

+ FootnoteRef func(out *bytes.Buffer, ref []byte, id int)

+ Footnotes func(out *bytes.Buffer, text func() bool)

+ GetFlags func() int

+ HRule func(out *bytes.Buffer)

+ Header func(out *bytes.Buffer, text func() bool, level int, id string)

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

+ LineBreak func(out *bytes.Buffer)

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

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

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

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

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

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

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

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

+ TableCell func(out *bytes.Buffer, text []byte, flags int)

+ TableHeaderCell func(out *bytes.Buffer, text []byte, flags int)

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

+ TitleBlock func(out *bytes.Buffer, text []byte)

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

v1.2.3

Sep 9, 2019

Changes in this version

+ const AutoHeadingIDs

+ const Autolink

+ const BackslashLineBreak

+ const CommonExtensions

+ const CommonHTMLFlags

+ const DefinitionLists

+ const FencedCode

+ const Footnotes

+ const HardLineBreak

+ const HeadingIDs

+ const LaxHTMLBlocks

+ const NoEmptyLineBeforeBlock

+ const NoExtensions

+ const NoIntraEmphasis

+ const SpaceHeadings

+ const Strikethrough

+ const TabSizeDefault

+ const TabSizeDouble

+ const TabSizeEight

+ const Tables

+ const Titleblock

+ const Version

+ func Run(input []byte, opts ...Option) []byte

+ func SanitizedAnchorName(text string) string

+ type CellAlignFlags int

+ const TableAlignmentCenter

+ const TableAlignmentLeft

+ const TableAlignmentRight

+ type CodeBlockData struct

+ FenceChar byte

+ FenceLength int

+ FenceOffset int

+ Info []byte

+ IsFenced bool

+ type Extensions int

+ type HTMLFlags int

+ const CompletePage

+ const FootnoteReturnLinks

+ const HTMLFlagsNone

+ const HrefTargetBlank

+ const NofollowLinks

+ const NoopenerLinks

+ const NoreferrerLinks

+ const Safelink

+ const SkipHTML

+ const SkipImages

+ const SkipLinks

+ const Smartypants

+ const SmartypantsAngledQuotes

+ const SmartypantsDashes

+ const SmartypantsFractions

+ const SmartypantsLatexDashes

+ const SmartypantsQuotesNBSP

+ const TOC

+ const UseXHTML

+ type HTMLRenderer struct

+ func NewHTMLRenderer(params HTMLRendererParameters) *HTMLRenderer

+ func (r *HTMLRenderer) RenderFooter(w io.Writer, ast *Node)

+ func (r *HTMLRenderer) RenderHeader(w io.Writer, ast *Node)

+ func (r *HTMLRenderer) RenderNode(w io.Writer, node *Node, entering bool) WalkStatus

+ type HTMLRendererParameters struct

+ AbsolutePrefix string

+ CSS string

+ Flags HTMLFlags

+ FootnoteAnchorPrefix string

+ FootnoteReturnLinkContents string

+ HeadingIDPrefix string

+ HeadingIDSuffix string

+ HeadingLevelOffset int

+ Icon string

+ Title string

+ type HeadingData struct

+ HeadingID string

+ IsTitleblock bool

+ Level int

+ type LinkData struct

+ Destination []byte

+ Footnote *Node

+ NoteID int

+ Title []byte

+ type ListData struct

+ BulletChar byte

+ Delimiter byte

+ IsFootnotesList bool

+ ListFlags ListType

+ RefLink []byte

+ Tight bool

+ type ListType int

+ const ListItemBeginningOfList

+ const ListItemContainsBlock

+ const ListItemEndOfList

+ const ListTypeDefinition

+ const ListTypeOrdered

+ const ListTypeTerm

+ type Markdown struct

+ func New(opts ...Option) *Markdown

+ func (p *Markdown) Parse(input []byte) *Node

+ type Node struct

+ FirstChild *Node

+ LastChild *Node

+ Literal []byte

+ Next *Node

+ Parent *Node

+ Prev *Node

+ Type NodeType

+ func NewNode(typ NodeType) *Node

+ func (n *Node) AppendChild(child *Node)

+ func (n *Node) InsertBefore(sibling *Node)

+ func (n *Node) IsContainer() bool

+ func (n *Node) IsLeaf() bool

+ func (n *Node) String() string

+ func (n *Node) Unlink()

+ func (n *Node) Walk(visitor NodeVisitor)

+ type NodeType int

+ const BlockQuote

+ const Code

+ const CodeBlock

+ const Del

+ const Document

+ const Emph

+ const HTMLBlock

+ const HTMLSpan

+ const Hardbreak

+ const Heading

+ const HorizontalRule

+ const Image

+ const Item

+ const Link

+ const List

+ const Paragraph

+ const Softbreak

+ const Strong

+ const Table

+ const TableBody

+ const TableCell

+ const TableHead

+ const TableRow

+ const Text

+ func (t NodeType) String() string

+ type NodeVisitor func(node *Node, entering bool) WalkStatus

+ type Option func(*Markdown)

+ func WithExtensions(e Extensions) Option

+ func WithNoExtensions() Option

+ func WithRefOverride(o ReferenceOverrideFunc) Option

+ func WithRenderer(r Renderer) Option

+ type Reference struct

+ Link string

+ Text string

+ Title string

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

+ type Renderer interface

+ RenderFooter func(w io.Writer, ast *Node)

+ RenderHeader func(w io.Writer, ast *Node)

+ RenderNode func(w io.Writer, node *Node, entering bool) WalkStatus

+ type SPRenderer struct

+ func NewSmartypantsRenderer(flags HTMLFlags) *SPRenderer

+ func (r *SPRenderer) Process(w io.Writer, text []byte)

+ type TableCellData struct

+ Align CellAlignFlags

+ IsHeader bool

+ type WalkStatus int

+ const GoToNext

+ const SkipChildren

+ const Terminate

Incompatible versions in this module

v2.0.0+incompatible

Aug 6, 2017