doku

README

blackfriday-doku

a renderer for blackfriday to output dokuwiki

usage

import (
        "github.com/russross/blackfriday"
        doku "github.com/seankhliao/blackfriday-dokuwiki"
)

func main() {
        b := ...
        b = blackfriday.Run(b, blackfriday.WithRenderer(doku.NewRenderer()))
}

Documentation

Index

• Constants
• type Renderer
  • func NewRenderer() *Renderer
  • func (r *Renderer) RenderFooter(w io.Writer, ast *blackfriday.Node)
  • func (r *Renderer) RenderHeader(w io.Writer, ast *blackfriday.Node)
  • func (r *Renderer) RenderNode(w io.Writer, node *blackfriday.Node, entering bool) blackfriday.WalkStatus

Examples

• Renderer

Constants

const (
	// Exts are the default supported extensions
	Exts = blackfriday.Tables | blackfriday.FencedCode | blackfriday.Autolink | blackfriday.Strikethrough | blackfriday.SpaceHeadings
)

Types

type Renderer

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

Renderer, a nil renderer is also valid

Example

input := []byte(`
# Example
this is *just* an
**example**

---

| thing | good |
| ----- | ----:|
| this  | yes  |
        `)
o := blackfriday.Run(input, blackfriday.WithRenderer(NewRenderer()), blackfriday.WithExtensions(Exts))
fmt.Printf("%s\n", o)

func NewRenderer

func NewRenderer() *Renderer

NewRenderer creates a new renderer

func (*Renderer) RenderFooter

func (r *Renderer) RenderFooter(w io.Writer, ast *blackfriday.Node)

RenderFooter is a noop for satisfying blackfriday's Renderer

func (*Renderer) RenderHeader

func (r *Renderer) RenderHeader(w io.Writer, ast *blackfriday.Node)

RenderHeader is a noop for satisfying blackfriday's Renderer

func (*Renderer) RenderNode

func (r *Renderer) RenderNode(w io.Writer, node *blackfriday.Node, entering bool) blackfriday.WalkStatus

RenderNode renders a node into output