parse

Documentation

Index

• func HeadingTitle(n *blackfriday.Node) string
• func IsHeading(n *blackfriday.Node) bool
• func Label(node *blackfriday.Node) string
• func PrintHeading(n *blackfriday.Node) string
• func PrintNode(n *blackfriday.Node) string
• func RichText(input string) string
• func Viz(graph *gographviz.Graph, graphName, parentID string, node *blackfriday.Node)
• type RawHeading
  • func Heading(content string, level int) (fi []RawHeading, err error)

Functions

func HeadingTitle

func HeadingTitle(n *blackfriday.Node) string

HeadingTitle returns the title of the heading by returning the Literal of its first child.

func IsHeading

func IsHeading(n *blackfriday.Node) bool

IsHeading returns true if node is type heading.

func Label

func Label(node *blackfriday.Node) string

Label returns a label for the node. Label is "Node.Type\n\Node.String()".

func PrintHeading

func PrintHeading(n *blackfriday.Node) string

PrintHeading returns the information of a Heading node.

func PrintNode

func PrintNode(n *blackfriday.Node) string

PrintNode returns a string representation of the node.

func RichText

func RichText(input string) string

RichText returns a string with the formatted rich text section.

func Viz

func Viz(graph *gographviz.Graph, graphName, parentID string, node *blackfriday.Node)

Viz adds a node to the graph and adds an edge to its parent.

Types

type RawHeading

type RawHeading struct {
	Title   string
	Content string
}

RawHeading represents a heading, raw content, and subheadings (if any).

func Heading

func Heading(content string, level int) (fi []RawHeading, err error)

Heading reads a markdown string and returns a slice of RawHeadings.