markdown

Documentation

Index

• Constants
• func Register(plugins *plugin.Plugins, config Config) chi.Router
• type Config
• type Router

Constants

const Route = "/markdown"

Route is the route under which the plugin should be registered in our router for the rest api.

Functions

func Register

func Register(plugins *plugin.Plugins, config Config) chi.Router

Register returns a new router which can be used in the router for the kobs rest api. The markdown plugin has always the same configuration and no api routes.

Types

type Config

type Config struct{}

Config is the structure of the configuration for the markdown plugin.

type Router

type Router struct {
	*chi.Mux
	// contains filtered or unexported fields
}

Router implements the router for the markdown plugin, which can be registered in the router for our rest api. It contains the api routes for the markdown plugin and it's configuration.