api

package

v0.1.0 Latest Latest Go to latest Published: Mar 16, 2022 License: Apache-2.0 Imports: 22 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

This section is empty.

This section is empty.

func FileSystemMiddleware(fallthroughHandler http.Handler, wdfs fs.FS) http.Handler

func NoCache(handler http.Handler) http.Handler

func RegisterConfigAPI(router *httprouter.Router, cfg *config.Components)

func RegisterEventsAPI(router *httprouter.Router, hub *events.EventHub, logger *log.Logger)

func RegisterViews(router *httprouter.Router, logger *log.Logger, wdfs fs.FS, mdFilepath string, cfg *config.Components)

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

func (a *ConfigAPI) MermaidConfig(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)

func (a *ConfigAPI) RevealConfig(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)

type ContentEventHandler chan events.ContentEvent

func (h ContentEventHandler) Close() (err error)

func (h ContentEventHandler) OnEvent(ce events.ContentEvent) error

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

func (e *Events) EventHandler(writer http.ResponseWriter, req *http.Request, _ httprouter.Params)

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

func (p *Views) IndexPage(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)

func (p *Views) RenderedMarkdown(writer http.ResponseWriter, _ *http.Request, _ httprouter.Params)