From bd892593b89663d1c0d5d5ca6d425c8918c1e80b Mon Sep 17 00:00:00 2001 From: Henrique Dias Date: Sun, 18 Oct 2015 17:16:40 +0100 Subject: [PATCH] update docs --- README.md | 57 ++++++++++++++++++++++++------------------------------- 1 file changed, 25 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 7e4b870a..4fd693c6 100644 --- a/README.md +++ b/README.md @@ -3,43 +3,36 @@ [![Build](https://img.shields.io/travis/hacdias/caddy-hugo.svg?style=flat-square)](https://travis-ci.org/hacdias/caddy-hugo) [![Documentation](https://img.shields.io/badge/godoc-reference-blue.svg?style=flat-square)](http://godoc.org/github.com/hacdias/caddy-hugo) -Powerful and easy static site generator with admin interface with [Hugo](http://gohugo.io/) (and you don't need to install it separately). +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. ## Build it from source -If you want to try caddy-hugo plugin (and improve it maybe), you'll have to install some tools. +### Requirements -+ [Go 1.4 or higher](https://golang.org/dl/) -+ [caddydev](https://github.com/caddyserver/caddydev) -+ [go-bindata](https://github.com/jteeuwen/go-bindata) +| 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. +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. -+ [Ruby](https://www.ruby-lang.org/en/) -+ [SASS](http://sass-lang.com/install) -+ [Node.js and npm](https://nodejs.org) -+ [Grunt](http://gruntjs.com/) +### Get it and build -### Run it +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. -If you have already installed everything above to meet the requirements for what you want to do, let's start. Firstly, open the terminal and navigate to your clone of ```caddy-hugo```. Then execute: - -``` -go-bindata [-debug] -pkg assets -o assets/assets.go templates/ assets/css/ assets/js/ assets/fonts/ -``` - -That command will create an ```assets.go``` file which contains all static files from those folders mentioned in the command. You may run with ```-debug``` option if you want, but it is only needed if you're going to make changes in front-end assets. - -Now, open the folder with your static website and create a Caddyfile. Read the [docs](http://caddyserver.com/docs/cms) for more information about the directives of this plugin. - -After creating the file, navigate to that folder using the terminal and run the following command, replacing ```{caddy-hugo}``` with the location of your clone. - -``` -caddydev --source {caddy-hugo} hugo -``` - -Navigate to the url you set on Caddyfile to see your blog running on Caddy and Hugo. Go to ```/admin``` to try the Admin UI. - -Everything is working now. Whenever you make a change in the back-end source code, you'll have to run the command above again. - -**For those who want to make changes in front-end**, make sure you have every needed tool installed and run ```npm install``` in the root of ```caddy-hugo``` clone. Then, run ```grunt watch```. +[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/