renderer

Documentation

Index

• Constants
• Variables
• func GenerateBoundary() string
• func Render(w io.Writer, nb *notebook.Notebook, opts ...RenderOpt) error
• func ToSideNote(id, content []byte) []byte
• type FootnoteRenderer
  • func (fnr *FootnoteRenderer) Patch(src []byte) ([]byte, error)
  • func (fnr *FootnoteRenderer) Render(w io.Writer, rawNode ast.Node, entering bool) (ast.WalkStatus, bool)
• type RenderOpt
  • func ImgSrcPrefix(prefix string) RenderOpt
• type Renderer
  • func New(w io.Writer, metadata *notebook.MetaData, opts ...RenderOpt) *Renderer
  • func NewInMemory(metadata *notebook.MetaData, opts ...RenderOpt) (*Renderer, *bytes.Buffer)
  • func (r *Renderer) Elide(tags []string) (cell bool, source bool, output bool)
  • func (r *Renderer) GetDefaultLang() string
  • func (r *Renderer) GetResource(contentHash string) *notebook.Resource
  • func (r *Renderer) GetResources() map[string]*notebook.Resource
  • func (r *Renderer) RenderNB(nb *notebook.Notebook) error
  • func (r *Renderer) SetMetadata(metadata notebook.MetaData)
  • func (r *Renderer) WriteB64Image(fig *notebook.Base64Figure) (string, error)
  • func (r *Renderer) WriteHTMLEscapedLines(lines []string) error
  • func (r *Renderer) WriteHTMLUnsafely(lines []string) error
  • func (r *Renderer) WriteMarkdownCodeFenced(lang string, lines []string) error
  • func (r *Renderer) WriteMarkdownLines(lines []string) error
  • func (r *Renderer) WriteOutputs(outputs []notebook.Output) error
  • func (r *Renderer) WritePlainText(class string, lines []string, clean bool) error
• type TaskListRenderer
  • func (tlr *TaskListRenderer) IsEngaged() bool
  • func (tlr *TaskListRenderer) Render(w io.Writer, rawNode ast.Node, entering bool) (ast.WalkStatus, bool)

Constants

const SideNoteFmt = `` /* 148-byte string literal not displayed */

Variables

var (
	DefaultRemoveCellTags   = map[string]bool{"remove_cell": true, "private": true, "setup": true, "notes": true, "hidden": true}
	DefaultRemoveInputTags  = map[string]bool{"remove_input": true, "output-generator": true}
	DefaultRemoveOutputTags = map[string]bool{"remove_output": true, "assertion": true}
)

var MarkdownHeaderRegexp = regexp.MustCompile(`^(#+)\s+(.+)`)

Functions

func GenerateBoundary

func GenerateBoundary() string

func Render

func Render(w io.Writer, nb *notebook.Notebook, opts ...RenderOpt) error

func ToSideNote

func ToSideNote(id, content []byte) []byte

Types

type FootnoteRenderer

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

func (*FootnoteRenderer) Patch

func (fnr *FootnoteRenderer) Patch(src []byte) ([]byte, error)

func (*FootnoteRenderer) Render

func (fnr *FootnoteRenderer) Render(w io.Writer, rawNode ast.Node, entering bool) (ast.WalkStatus, bool)

type RenderOpt

type RenderOpt func(*Renderer)

func ImgSrcPrefix

func ImgSrcPrefix(prefix string) RenderOpt

type Renderer

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

func New

func New(w io.Writer, metadata *notebook.MetaData, opts ...RenderOpt) *Renderer

func NewInMemory

func NewInMemory(metadata *notebook.MetaData, opts ...RenderOpt) (*Renderer, *bytes.Buffer)

func (*Renderer) Elide

func (r *Renderer) Elide(tags []string) (cell bool, source bool, output bool)

func (*Renderer) GetDefaultLang

func (r *Renderer) GetDefaultLang() string

func (*Renderer) GetResource

func (r *Renderer) GetResource(contentHash string) *notebook.Resource

func (*Renderer) GetResources

func (r *Renderer) GetResources() map[string]*notebook.Resource

func (*Renderer) RenderNB

func (r *Renderer) RenderNB(nb *notebook.Notebook) error

func (*Renderer) SetMetadata

func (r *Renderer) SetMetadata(metadata notebook.MetaData)

func (*Renderer) WriteB64Image

func (r *Renderer) WriteB64Image(fig *notebook.Base64Figure) (string, error)

func (*Renderer) WriteHTMLEscapedLines

func (r *Renderer) WriteHTMLEscapedLines(lines []string) error

func (*Renderer) WriteHTMLUnsafely

func (r *Renderer) WriteHTMLUnsafely(lines []string) error

func (*Renderer) WriteMarkdownCodeFenced

func (r *Renderer) WriteMarkdownCodeFenced(lang string, lines []string) error

func (*Renderer) WriteMarkdownLines

func (r *Renderer) WriteMarkdownLines(lines []string) error

func (*Renderer) WriteOutputs

func (r *Renderer) WriteOutputs(outputs []notebook.Output) error

func (*Renderer) WritePlainText

func (r *Renderer) WritePlainText(class string, lines []string, clean bool) error

type TaskListRenderer

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

func (*TaskListRenderer) IsEngaged

func (tlr *TaskListRenderer) IsEngaged() bool

func (*TaskListRenderer) Render

func (tlr *TaskListRenderer) Render(w io.Writer, rawNode ast.Node, entering bool) (ast.WalkStatus, bool)

See: https://github.blog/2014-04-28-task-lists-in-all-markdown-documents/