hugo

README

Hugo plugin for Caddy

Caddy-hugo fills the gap between Hugo and the browser. Hugo is an easy, blazing fast and awesome static website generator. This plugin fills the gap between Hugo and the end-user, providing you an web interface to manage the whole website.

The following information is directed to developers. If you just want to use it, read the documentation at Caddy website.

Build from source

Requirements

• Go 1.4 or higher
• caddydev
• go-bindata
• Node.js w/ npm (optional)

If you want to go deeper and make changes in front-end assets like JavaScript or CSS, you'll need to install the optional tools listed above.

Get it and build

1. Open the terminal.
2. Run go get github.com/hacdias/caddy-hugo.
3. Navigate to the clone path.
4. If you want to make changes in the front-end change the last comment in the beginning of hugo.go file to //go:generate go-bindata -debug -pkg assets -o assets/assets.go templates/ assets/css/ assets/js/ assets/fonts/; execute npm install in the root of caddy-hugo clone. Then, run grunt watch.
5. Run go generate.
6. Open the folder with your static website and create a Caddyfile. Read the docs for more information about the directives of this plugin.
7. Open the console in that folder and execute caddydev --source $PATH$ hugo, replacing $PATH with the absolute path to your caddy-hugo's clone.
8. Open the browser and go to http://whateveryoururlis/admin to check it out.

Documentation

Overview

Package hugo makes the bridge between the static website generator Hugo and the webserver Caddy, also providing an administrative user interface.

Index

• func Setup(c *setup.Controller) (middleware.Middleware, error)
• type CaddyHugo
  • func (h CaddyHugo) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

Functions

func Setup

func Setup(c *setup.Controller) (middleware.Middleware, error)

Setup is the init function of Caddy plugins and it configures the whole middleware thing.

Types

type CaddyHugo

type CaddyHugo struct {
	Next   middleware.Handler
	Config *config.Config
}

CaddyHugo contais the next middleware to be run and the configuration of the current one.

func (CaddyHugo) ServeHTTP

func (h CaddyHugo) ServeHTTP(w http.ResponseWriter, r *http.Request) (int, error)

ServeHTTP is the main function of the whole plugin that routes every single request to its function.