rundoc

package

v0.0.0-...-16bf92b Latest Latest Go to latest Published: Feb 20, 2022 License: MPL-2.0 Imports: 19 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fvumbaca/mdrun

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func RenderDoc(w io.Writer, doc *Rundoc)
type CMDFunc
type HTMLRenderer
- func NewHTMLRenderer() *HTMLRenderer
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)

Constants ¶

This section is empty.

Variables ¶

View Source

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)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL