chiu
/
filebrowser
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 1 Wiki Activity

update readme

This commit is contained in:
Henrique Dias 2016-06-08 14:46:09 +01:00
parent 5be9e11ab0
commit 22141d3134
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,37 +1,37 @@
# Hugo plugin for Caddy
# hugo - a caddy plugin
[![Build](https://img.shields.io/travis/hacdias/caddy-hugo.svg?style=flat-square)](https://travis-ci.org/hacdias/caddy-hugo)
[![Chat](https://img.shields.io/badge/chat-gitter-yellow.svg?style=flat-square)](https://gitter.im/hacdias/caddy-hugo)
[![community](https://img.shields.io/badge/community-forum-ff69b4.svg?style=flat-square)](https://forum.caddyserver.com)
[![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)
[![Executables](https://img.shields.io/bintray/v/hacdias/generic/caddy-hugo.svg?style=flat-square)](https://bintray.com/hacdias/generic/caddy-hugo/)
**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.
[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.
*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*.
**If you're not developer go to the [documentation](https://caddyserver.com/docs/hugo)**.
## Build from source
**Requirements**
Requirements:
+ [Go 1.6 or higher][1]
+ [caddydev][2]
+ [go-bindata][3]
+ [Node.js w/ npm][4] (optional)
Instructions:
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](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.
1. ```go get github.com/hacdias/caddy-hugo```
2. ```cd $GOPATH/github.com/hacdias/caddy-hugo```
1. If you want to modify the CSS/JS:
2. Change the third comment to ```//go:generate go-bindata -debug -pkg assets -o assets/assets.go templates/ assets/css/ assets/js/ assets/fonts/```
3. ```npm install```
4. ```grunt watch```
3. ```go generate```
4. ```cd $YOUR_WEBSITE_PATH```
5. ```caddydev --source $GOPATH/github.com/hacdias/caddy-hugo hugo```
6. Go to ```http://domain:port```
[1]: https://golang.org/dl/
[2]: https://github.com/caddyserver/caddydev