rundoc

Documentation

Index

• Variables
• func RenderDoc(w io.Writer, doc *Rundoc)
• type CMDFunc
• type HTMLRenderer
  • func NewHTMLRenderer() *HTMLRenderer
  • func (r *HTMLRenderer) RenderFooter(w io.Writer, ast *blackfriday.Node)
  • func (r *HTMLRenderer) RenderHeader(w io.Writer, ast *blackfriday.Node)
  • func (r *HTMLRenderer) RenderNode(w io.Writer, node *blackfriday.Node, entering bool) blackfriday.WalkStatus
• type Handler
  • func NewHandler(rootDir fs.FS) *Handler
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)
• type LangExecCMDMap
• type Rundoc
  • func Parse(input []byte) (*Rundoc, error)

Variables

var DefaultCMDMap = LangExecCMDMap{

	"sh": buildStdinCMDFunc("sh"),
	"text": func(ctx context.Context, script []byte) ([]byte, error) {
		return script, nil
	},
}

Functions

func RenderDoc

func RenderDoc(w io.Writer, doc *Rundoc)

Types

type CMDFunc

type CMDFunc func(context.Context, []byte) ([]byte, error)

type HTMLRenderer

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

func NewHTMLRenderer

func NewHTMLRenderer() *HTMLRenderer

func (*HTMLRenderer) RenderFooter

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

func (*HTMLRenderer) RenderHeader

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

func (*HTMLRenderer) RenderNode

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

type Handler

type Handler struct {
	RootFS fs.FS
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(rootDir fs.FS) *Handler

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type LangExecCMDMap

type LangExecCMDMap map[string]CMDFunc

type Rundoc

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

func Parse

func Parse(input []byte) (*Rundoc, error)