filebrowser/README.md

40 lines
2.2 KiB
Markdown
Raw Normal View History

2015-10-18 14:57:28 +00:00
# Hugo plugin for Caddy
2015-09-12 15:20:24 +00:00
2015-10-17 07:12:33 +00:00
[![Build](https://img.shields.io/travis/hacdias/caddy-hugo.svg?style=flat-square)](https://travis-ci.org/hacdias/caddy-hugo)
2016-02-08 09:14:25 +00:00
[![Documentation] (https://img.shields.io/badge/caddy-doc-F06292.svg?style=flat-square](https://caddyserver.com/docs/hugo)
2015-10-17 07:12:33 +00: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 08:56:01 +00:00
2015-10-18 16:16:40 +00:00
Powerful [Hugo](http://gohugo.io/) - easy and amazing static website generator - plugin for Caddy with an admin interface so you can change your website when you're not on your computer. You can also use it like any other Content Management Service.
2015-09-20 21:00:25 +00:00
2015-09-20 21:32:31 +00:00
## Build it from source
2015-09-16 12:58:36 +00:00
2015-10-18 16:16:40 +00:00
### Requirements
| Back-end | Front-end |
| --------------------- | -------------------- |
| [Go 1.4 or higher][1] | [Ruby][2] |
| [caddydev][3] | [SASS][4] |
| [go-bindata][5] | [Node.js w/ npm][6] |
| | [Grunt][7] |
If you want to go deeper and make changes in front-end assets like JavaScript or CSS, you'll need some more tools (front-end tools in the table bellow). If you don't, install only the back-end tools.
### Get it and build
1. Open the terminal.
2. Run ```go get github.com/hacdias/caddy-hugo```.
3. Navigate to the clone path.
4. Run ```go generate```.
+ If you want to make changes in the front-end, run ```go-bindata -debug -pkg assets -o assets/assets.go templates/ assets/css/ assets/js/ assets/fonts/``` too; execute ```npm install``` in the root of ```caddy-hugo``` clone. Then, run ```grunt watch```.
5. 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.
6. Open the console in that folder and execute ```caddydev --source $PATH$ hugo```, replacing ```$PATH``` with the absolute path to your caddy-hugo's clone.
7. Open the browser and go to ```http://whateveryoururlis/admin``` to check it out.
[1]: https://golang.org/dl/
[2]: https://www.ruby-lang.org/en/
[3]: https://github.com/caddyserver/caddydev
[4]: http://sass-lang.com/install
[5]: https://github.com/jteeuwen/go-bindata
[6]: https://nodejs.org
[7]: http://gruntjs.com/