plugin

Documentation

Overview

Package plugin contains all the rules that are not part of Commonmark like GitHub Flavored Markdown.

Index

• Constants
• Variables
• func ConfluenceAttachments() md.Plugin
• func ConfluenceCodeBlock() md.Plugin
• func EXPERIMENTAL_FrontMatter(format string) md.Plugin
• func EXPERIMENTAL_VimeoEmbed(variation vimeoVariation) md.Plugin
• func GitHubFlavored() md.Plugin
• func Strikethrough(character string) md.Plugin
• func TaskListItems() md.Plugin

Constants

const (
	VimeoOnlyThumbnail vimeoVariation = iota
	VimeoWithTitle
	VimeoWithDescription
)

Configure how the Vimeo Plugin should display the video in markdown.

Variables

var EXPERIMENTAL_Table = []md.Rule{
	{
		Filter: []string{"th", "td"},
		Replacement: func(content string, selec *goquery.Selection, opt *md.Options) *string {
			return md.String(cell(content, selec))
		},
	},
	{
		Filter: []string{"tr"},
		Replacement: func(content string, selec *goquery.Selection, opt *md.Options) *string {
			borderCells := ""

			if isHeadingRow(selec) {
				selec.Children().Each(func(i int, s *goquery.Selection) {
					border := "---"
					if align, ok := s.Attr("align"); ok {
						switch align {
						case "left":
							border = ":--"
						case "right":
							border = "--:"
						case "center":
							border = ":-:"
						}
					}

					borderCells += cell(border, s)
				})
			}

			text := "\n" + content
			if borderCells != "" {
				text += "\n" + borderCells
			}
			return &text
		},
	},
}

EXPERIMENTAL_Table converts a html table to markdown.

var EXPERIMENTAL_YoutubeEmbed = []md.Rule{
	{
		Filter: []string{"iframe"},
		Replacement: func(content string, selec *goquery.Selection, opt *md.Options) *string {
			src := selec.AttrOr("src", "")
			if !strings.Contains(src, "www.youtube.com") {
				return nil
			}
			alt := selec.AttrOr("title", "")

			parts := youtubeID.FindStringSubmatch(src)
			if len(parts) != 2 {
				return nil
			}
			id := parts[1]

			text := fmt.Sprintf("[![%s](https://img.youtube.com/vi/%s/0.jpg)](https://www.youtube.com/watch?v=%s)", alt, id, id)
			return &text
		},
	},
}

EXPERIMENTAL_YoutubeEmbed registers a rule (for iframes) and returns a markdown compatible representation (link to video, ...).

var Timeout = time.Second * 10

Timeout for the http client

Functions

func ConfluenceAttachments

func ConfluenceAttachments() md.Plugin

ConfluenceAttachments converts `<ri:attachment ri:filename=""/>` elements [Contributed by @Skarlso]

func ConfluenceCodeBlock

func ConfluenceCodeBlock() md.Plugin

ConfluenceCodeBlock converts `<ac:structured-macro>` elements that are used in Atlassian’s Wiki “Confluence”. [Contributed by @Skarlso]

func EXPERIMENTAL_FrontMatter

func EXPERIMENTAL_FrontMatter(format string) md.Plugin

func EXPERIMENTAL_VimeoEmbed

func EXPERIMENTAL_VimeoEmbed(variation vimeoVariation) md.Plugin

EXPERIMENTAL_VimeoEmbed registers a rule (for iframes) and returns a markdown compatible representation (link to video, ...).

func GitHubFlavored

func GitHubFlavored() md.Plugin

GitHubFlavored is GitHub's Flavored Markdown

func Strikethrough

func Strikethrough(character string) md.Plugin

Strikethrough converts `<strike>`, `<s>`, and `<del>` elements

func TaskListItems

func TaskListItems() md.Plugin

TaskListItems converts checkboxes into task list items.