pkg

Documentation

Index

• func Init(path string) error
• func Version() string
• type Server
  • func NewServer(dir string, options ServerOptions) (*Server, error)
  • func (server *Server) Start(cancel context.CancelFunc) error
• type ServerOptions

Functions

func Init

func Init(path string) error

Init creates a new Shifu project directory structure in given directory.

func Version

func Version() string

Version returns the Shifu version number.

Types

type Server

type Server struct {
	// Content is the CMS content.
	Content *cms.CMS

	// Sitemap is the sitemap generated from the content.
	Sitemap *sitemap.Sitemap
	// contains filtered or unexported fields
}

Server is the Shifu server.

func NewServer

func NewServer(dir string, options ServerOptions) (*Server, error)

NewServer creates a new Shifu server for the given directory. The second argument is an optional template.FuncMap that will be merged with Shifu's func map.

func (*Server) Start

func (server *Server) Start(cancel context.CancelFunc) error

Start starts the Shifu server. The context.CancelFunc is optional and will be called on server shutdown or error if set.

type ServerOptions

type ServerOptions struct {
	// Router is the router used by the server. If set, it will be used to attach the Shifu handlers.
	// Otherwise, a new router will be created.
	Router chi.Router

	// FuncMap will be merged with the default Shifu template function map.
	FuncMap template.FuncMap
}

ServerOptions are the options for the Shifu Server.