filebrowser/README.md

38 lines
2.1 KiB
Markdown
Raw Normal View History

2015-10-18 22:57:28 +08:00
# Hugo plugin for Caddy
2015-09-12 23:20:24 +08:00
2015-10-17 15:12:33 +08:00
[![Build](https://img.shields.io/travis/hacdias/caddy-hugo.svg?style=flat-square)](https://travis-ci.org/hacdias/caddy-hugo)
2016-02-08 17:15:06 +08:00
[![Documentation](https://img.shields.io/badge/caddy-doc-F06292.svg?style=flat-square)](https://caddyserver.com/docs/hugo)
2015-10-17 15:12:33 +08:00
[![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/hacdias/caddy-hugo)
2015-09-27 16:56:01 +08:00
2016-02-08 20:37:16 +08:00
**Caddy-hugo fills the gap between Hugo and the browser.** [Hugo](http://gohugo.io/) 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.
2015-09-21 05:00:25 +08:00
2016-02-09 03:30:01 +08:00
*The following information is directed to developers. If you just want to use it, read the [documentation](https://caddyserver.com/docs/hugo) at Caddy website*.
2016-02-08 20:03:42 +08:00
## Build from source
2015-09-16 20:58:36 +08:00
2016-02-09 03:30:01 +08:00
**Requirements**
2015-10-19 00:16:40 +08:00
2016-02-08 20:03:42 +08:00
+ [Go 1.4 or higher][1]
2016-02-09 03:30:01 +08:00
+ [caddydev][2]
+ [go-bindata][3]
+ [Node.js w/ npm][4] (optional)
2016-02-08 20:03:42 +08:00
2015-10-19 00:16:40 +08:00
2016-02-09 03:30:01 +08:00
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.
2015-10-19 00:16:40 +08:00
2016-02-09 03:30:01 +08:00
**Get it and build**
2015-10-19 00:16:40 +08:00
1. Open the terminal.
2. Run ```go get github.com/hacdias/caddy-hugo```.
3. Navigate to the clone path.
2016-02-09 03:30:01 +08:00
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](http://caddyserver.com/docs/hugo) 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.
2015-10-19 00:16:40 +08:00
[1]: https://golang.org/dl/
2016-02-09 03:30:01 +08:00
[2]: https://github.com/caddyserver/caddydev
[3]: https://github.com/jteeuwen/go-bindata
[4]: https://nodejs.org