markup

Documentation

Index

• func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
• func RenderString(ctx *markup.RenderContext, content string) (string, error)
• type Renderer
  • func (Renderer) Extensions() []string
  • func (Renderer) Name() string
  • func (Renderer) NeedPostProcess() bool
  • func (Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error
  • func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule
• type Writer
  • func (r *Writer) WriteRegularLink(l org.RegularLink)

Functions

func Render

func Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error

Render renders orgmode rawbytes to HTML

func RenderString

func RenderString(ctx *markup.RenderContext, content string) (string, error)

RenderString renders orgmode string to HTML string

Types

type Renderer

type Renderer struct{}

Renderer implements markup.Renderer for orgmode

func (Renderer) Extensions

func (Renderer) Extensions() []string

Extensions implements markup.Renderer

func (Renderer) Name

func (Renderer) Name() string

Name implements markup.Renderer

func (Renderer) NeedPostProcess

func (Renderer) NeedPostProcess() bool

NeedPostProcess implements markup.PostProcessRenderer

func (Renderer) Render

func (Renderer) Render(ctx *markup.RenderContext, input io.Reader, output io.Writer) error

Render renders orgmode string to HTML string

func (Renderer) SanitizerRules

func (Renderer) SanitizerRules() []setting.MarkupSanitizerRule

SanitizerRules implements markup.Renderer

type Writer

type Writer struct {
	*org.HTMLWriter
	URLPrefix string
	IsWiki    bool
}

Writer implements org.Writer

func (*Writer) WriteRegularLink

func (r *Writer) WriteRegularLink(l org.RegularLink)

WriteRegularLink renders images, links or videos