From 1a7c2db84affa2fac87f8d6aea2063568db34360 Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Sat, 25 Mar 2017 20:12:30 +0000 Subject: [PATCH] Update README.md --- README.md | 38 ++++++++++++++++++++++++++++++++++---- 1 file changed, 34 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3f7ae1a0..19d6adaf 100644 --- a/README.md +++ b/README.md @@ -5,10 +5,40 @@ [![Documentation](https://img.shields.io/badge/caddy-doc-F06292.svg?style=flat-square)](https://caddyserver.com/docs/hugo) [![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/hacdias/caddy-hugo) -[Hugo](http://gohugo.io/) is an easy to use and fast command line static website generator, while [Caddy](http://caddyserver.com) is a lightweight, fast, general-purpose, cross-platform HTTP/2 web server with automatic HTTPS. This extension is able to bring a web interface to Caddy to manage Hugo generated websites. This plugin provides you an web interface to manage your websites made with Hugo. -**If you're not developer go to the [documentation](https://caddyserver.com/docs/hugo)**. +hugo fills the gap between Hugo and the browser. [Hugo](http://gohugo.io/) is an easy and fast static website generator. This plugin fills the gap between Hugo and the end-user, providing you an web interface to manage the whole website. -## NOTE FOR DEVELOPERS +Using this plugin, you won't need to have your own computer to edit posts, neither regenerate your static website, because you can do all of that just through your browser. -You need to run `go generate` on `$GOPATH/src/github.com/hacdias/caddy-hugo` before building any binary. Otherwise, you will receive an `undefined: Asset` error. +**Requirements:** you need to have the hugo executable in your PATH. You can download it from its [official page](http://gohugo.io). + +### Syntax + +``` +hugo [directory] [admin] { + flag name [value] + # other file manager compatible options +} +``` + +All of the options above are optional. + +* **directory** is the folder where the commands are going to be executed. By default, it is the current working directory. Default: `./`. +* **admin** is the path where you will find your administration interface. Default: `/admin`. +* **name** refers to the Hugo available flags. Please use their long form without `--` in the beginning. If no **value** is set, it will be evaluated as `true`. + +In spite of these options, you can also use the [filemanager](/docs/filemanager) so you can have more control about what can be acceded, the permissions of each user, and so on. + +This directive should be used with [root](/docs/root), [basicauth](/docs/basicauth) and [errors](/docs/errors) middleware to have the best experience. See the examples to know more. + +### Examples + +If you don't already have an Hugo website, don't worry. This plugin will auto-generate it for you. But that's not everything. It is recommended that you take a look at Hugo [documentation](http://gohugo.io/themes/overview/) to learn more about themes, content types, and so on. + +A simple Caddyfile to use with Hugo static website generator: + +``` +root public # the folder where Hugo generates the website +basicauth /admin user pass # protect the admin area using HTTP basic auth +hugo # enable the admin panel +```