mdgithub

Documentation

Overview

Package mdgithub provides Github-flavored Markdown extensions to vfmd. Not all are implemented yet. On the other hand, some are already implemented by base vfmd.

Reference: https://help.github.com/articles/github-flavored-markdown/

Index

• type FencedCodeBlock
  • func (FencedCodeBlock) Detect(first, second mdblock.Line, detectors mdblock.Detectors) mdblock.Handler
  • func (b FencedCodeBlock) HTMLBlock(ctx mdhtml.Context, opt mdhtml.Opt) ([]md.Tag, error)
• type StrikeThrough
  • func (StrikeThrough) Detect(ctx *mdspan.Context) (consumed int)
  • func (s StrikeThrough) HTMLSpan(ctx mdhtml.Context, opt mdhtml.Opt) ([]md.Tag, error)

Types

type FencedCodeBlock

type FencedCodeBlock struct {
	// TODO(akavel): Language string
	md.Prose
	md.Raw
}

func (FencedCodeBlock) Detect

func (FencedCodeBlock) Detect(first, second mdblock.Line, detectors mdblock.Detectors) mdblock.Handler

func (FencedCodeBlock) HTMLBlock

func (b FencedCodeBlock) HTMLBlock(ctx mdhtml.Context, opt mdhtml.Opt) ([]md.Tag, error)

type StrikeThrough

type StrikeThrough struct{}

func (StrikeThrough) Detect

func (StrikeThrough) Detect(ctx *mdspan.Context) (consumed int)

func (StrikeThrough) HTMLSpan

func (s StrikeThrough) HTMLSpan(ctx mdhtml.Context, opt mdhtml.Opt) ([]md.Tag, error)