markdown

Documentation

Index

• Variables
• type Converter
  • func NewConverter() *Converter
  • func (r *Converter) Convert(data []byte) (*Document, error)
• type Document
• type PagePreviewText
• type ShortCodeNode
  • func (n *ShortCodeNode) Dump(source []byte, level int)
  • func (n *ShortCodeNode) Kind() gast.NodeKind

Variables

var (
	// EnableShortcodes context key for indicates if shortcodes enabled
	EnableShortcodes = parser.NewContextKey()
	// UsedShortcodesKey store list of used shortcodes on page
	UsedShortcodesKey = parser.NewContextKey()
)

var ShortCodeNodeKinds = map[string]gast.NodeKind{
	// contains filtered or unexported fields
}

ShortCodeNodeKinds mapping `keyword -> NodeKind`

var TableOfContentsShortcode = &tocExtender{}

TableOfContentsShortcode allows to insert Table Of Contents with {{ toc }} shortcode

Types

type Converter

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

Render renders markdown to html

func NewConverter

func NewConverter() *Converter

NewRender create new renderer

func (*Converter) Convert

func (r *Converter) Convert(data []byte) (*Document, error)

Converter markdown to html

type Document

type Document struct {
	Title   string
	Preview string
	Body    string
}

type PagePreviewText

type PagePreviewText struct {
	Title   string
	Preview string
}

PagePreviewText contains title of document and beginning of content

type ShortCodeNode

type ShortCodeNode struct {
	gast.BaseInline
	// contains filtered or unexported fields
}

A ShortCodeNode struct represents a tweet ast node

func (*ShortCodeNode) Dump

func (n *ShortCodeNode) Dump(source []byte, level int)

Dump for ShortCodeNode

func (*ShortCodeNode) Kind

func (n *ShortCodeNode) Kind() gast.NodeKind

Kind implements Node.Kind.