staticgen

Documentation

Index

• type Hugo
  • func (h Hugo) Hook(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)
  • func (h Hugo) Name() string
  • func (h *Hugo) Preview(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)
  • func (h Hugo) Publish(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)
  • func (h Hugo) SettingsPath() string
  • func (h *Hugo) Setup() error
• type Jekyll
  • func (j Jekyll) Hook(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)
  • func (j Jekyll) Name() string
  • func (j *Jekyll) Preview(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)
  • func (j Jekyll) Publish(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)
  • func (j Jekyll) SettingsPath() string
  • func (j *Jekyll) Setup() error

Types

type Hugo

type Hugo struct {
	// Website root
	Root string `name:"Website Root"`
	// Public folder
	Public string `name:"Public Directory"`
	// Hugo executable path
	Exe string `name:"Hugo Executable"`
	// Hugo arguments
	Args []string `name:"Hugo Arguments"`
	// Indicates if we should clean public before a new publish.
	CleanPublic bool `name:"Clean Public"`
	// contains filtered or unexported fields
}

Hugo is the Hugo static website generator.

func (Hugo) Hook

func (h Hugo) Hook(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)

Hook is the pre-api handler.

func (Hugo) Name

func (h Hugo) Name() string

Name is the plugin's name.

func (*Hugo) Preview

func (h *Hugo) Preview(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)

Preview handles the preview path.

func (Hugo) Publish

func (h Hugo) Publish(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)

Publish publishes a post.

func (Hugo) SettingsPath

func (h Hugo) SettingsPath() string

SettingsPath retrieves the correct settings path.

func (*Hugo) Setup

func (h *Hugo) Setup() error

Setup sets up the plugin.

type Jekyll

type Jekyll struct {
	// Website root
	Root string `name:"Website Root"`
	// Public folder
	Public string `name:"Public Directory"`
	// Jekyll executable path
	Exe string `name:"Executable"`
	// Jekyll arguments
	Args []string `name:"Arguments"`
	// Indicates if we should clean public before a new publish.
	CleanPublic bool `name:"Clean Public"`
	// contains filtered or unexported fields
}

Jekyll is the Jekyll static website generator.

func (Jekyll) Hook

func (j Jekyll) Hook(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)

Hook is the pre-api handler.

func (Jekyll) Name

func (j Jekyll) Name() string

Name is the plugin's name.

func (*Jekyll) Preview

func (j *Jekyll) Preview(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)

Preview handles the preview path.

func (Jekyll) Publish

func (j Jekyll) Publish(c *fb.Context, w http.ResponseWriter, r *http.Request) (int, error)

Publish publishes a post.

func (Jekyll) SettingsPath

func (j Jekyll) SettingsPath() string

SettingsPath retrieves the correct settings path.

func (*Jekyll) Setup

func (j *Jekyll) Setup() error

Setup sets up the plugin.