katex

README

goldmark-katex

Copy for goldmark-mathjax. Used by mdserver.

Installation

go get github.com/kingreatwill/goldmark-katex

Usage

package main

import (
	"bytes"
	"fmt"

	katex "github.com/kingreatwill/goldmark-katex"
	"github.com/yuin/goldmark"
	"github.com/yuin/goldmark/parser"
	"github.com/yuin/goldmark/renderer/html"
)

func main() {
	md := goldmark.New(
		goldmark.WithExtensions(katex.KaTeX),
		goldmark.WithParserOptions(
			parser.WithAutoHeadingID(),
		),
		goldmark.WithRendererOptions(
			html.WithHardWraps(),
			html.WithXHTML(),
		),
	)

	// todo more control on the parsing process
	var html bytes.Buffer
	mdContent := []byte(`
$$
\mathbb{E}(X) = \int x d F(x) = \left\{ \begin{aligned} \sum_x x f(x) \; & \text{ if } X \text{ is discrete} 
\\ \int x f(x) dx \; & \text{ if } X \text{ is continuous }
\end{aligned} \right.
$$


Inline math $\frac{1}{2}$
`)
	if err := md.Convert(mdContent, &html); err != nil {
		fmt.Println(err)
	}
	fmt.Println(html.String())
}

License

MIT

Documentation

Index

• Variables
• func NewInlineMathParser() parser.InlineParser
• func NewInlineMathRenderer(start, end string) renderer.NodeRenderer
• func NewKaTeX(opts ...Option) *katex
• func NewMathBlockRenderer(start, end string) renderer.NodeRenderer
• func NewMathJaxBlockParser() parser.BlockParser
• type InlineMath
  • func NewInlineMath() *InlineMath
  • func (n *InlineMath) Dump(source []byte, level int)
  • func (n *InlineMath) Inline()
  • func (n *InlineMath) IsBlank(source []byte) bool
  • func (n *InlineMath) Kind() ast.NodeKind
• type InlineMathRenderer
  • func (r *InlineMathRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type InlineTexMathRenderer
  • func (r *InlineTexMathRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type MathBlock
  • func NewMathBlock() *MathBlock
  • func (n *MathBlock) Dump(source []byte, level int)
  • func (n *MathBlock) IsRaw() bool
  • func (n *MathBlock) Kind() ast.NodeKind
• type MathBlockRenderer
  • func (r *MathBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type MathTexBlockRenderer
  • func (r *MathTexBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
• type Option
  • func WithBlockDelim(start string, end string) Option
  • func WithInlineDelim(start string, end string) Option
• type TexRenderer
  • func NewDefaultTexRenderer() *TexRenderer
  • func (r *TexRenderer) Run(formula string) []byte
  • func (r *TexRenderer) RunInline(formula string) []byte

Variables

var KaTeX = &katex{
	inlineStartDelim: `\(`,
	inlineEndDelim:   `\)`,
	blockStartDelim:  `\[`,
	blockEndDelim:    `\]`,
}

var KindInlineMath = ast.NewNodeKind("InlineMath")

var KindMathBlock = ast.NewNodeKind("MathBLock")

var Tex = &tex{
	texRenderer: NewDefaultTexRenderer(),
}

Functions

func NewInlineMathParser

func NewInlineMathParser() parser.InlineParser

func NewInlineMathRenderer

func NewInlineMathRenderer(start, end string) renderer.NodeRenderer

func NewKaTeX

func NewKaTeX(opts ...Option) *katex

func NewMathBlockRenderer

func NewMathBlockRenderer(start, end string) renderer.NodeRenderer

func NewMathJaxBlockParser

func NewMathJaxBlockParser() parser.BlockParser

Types

type InlineMath

type InlineMath struct {
	ast.BaseInline
}

func NewInlineMath

func NewInlineMath() *InlineMath

func (*InlineMath) Dump

func (n *InlineMath) Dump(source []byte, level int)

func (*InlineMath) Inline

func (n *InlineMath) Inline()

func (*InlineMath) IsBlank

func (n *InlineMath) IsBlank(source []byte) bool

func (*InlineMath) Kind

func (n *InlineMath) Kind() ast.NodeKind

type InlineMathRenderer

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

func (*InlineMathRenderer) RegisterFuncs

func (r *InlineMathRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

type InlineTexMathRenderer

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

func (*InlineTexMathRenderer) RegisterFuncs

func (r *InlineTexMathRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

type MathBlock

type MathBlock struct {
	ast.BaseBlock
}

func NewMathBlock

func NewMathBlock() *MathBlock

func (*MathBlock) Dump

func (n *MathBlock) Dump(source []byte, level int)

func (*MathBlock) IsRaw

func (n *MathBlock) IsRaw() bool

func (*MathBlock) Kind

func (n *MathBlock) Kind() ast.NodeKind

type MathBlockRenderer

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

func (*MathBlockRenderer) RegisterFuncs

func (r *MathBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

type MathTexBlockRenderer

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

func (*MathTexBlockRenderer) RegisterFuncs

func (r *MathTexBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)

type Option

type Option interface {
	SetOption(e *katex)
}

func WithBlockDelim

func WithBlockDelim(start string, end string) Option

func WithInlineDelim

func WithInlineDelim(start string, end string) Option

type TexRenderer

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

func NewDefaultTexRenderer

func NewDefaultTexRenderer() *TexRenderer

func (*TexRenderer) Run

func (r *TexRenderer) Run(formula string) []byte

func (*TexRenderer) RunInline

func (r *TexRenderer) RunInline(formula string) []byte