github
/
filebrowser
mirror of https://github.com/filebrowser/filebrowser
1
0
Fork 0
Code Issues Releases Wiki Activity

update readme

pull/48/head
Henrique Dias 2016-02-08 19:30:01 +00:00
parent c81c1d3bf1
commit 5a609a2c0d
1 changed files with 15 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -6,35 +6,32 @@
**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. **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.
The following information is directed to those who want to build the plugin from source and make changes to it. If you just want to try it out, read the [documentation](https://caddyserver.com/docs/hugo) at Caddy website. *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*.
## Build from source ## Build from source
### Requirements **Requirements**
+ [Go 1.4 or higher][1] + [Go 1.4 or higher][1]
+ [caddydev][3] + [caddydev][2]
+ [go-bindata][5] + [go-bindata][3]
+ [Node.js w/ npm][6] (optional) + [Node.js w/ npm][4] (optional)
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. 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 **Get it and build**
1. Open the terminal. 1. Open the terminal.
2. Run ```go get github.com/hacdias/caddy-hugo```. 2. Run ```go get github.com/hacdias/caddy-hugo```.
3. Navigate to the clone path. 3. Navigate to the clone path.
4. Run ```go generate```. 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```.
+ 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. Run ```go generate```.
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 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 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. 8. Open the browser and go to ```http://whateveryoururlis/admin``` to check it out.
[1]: https://golang.org/dl/ [1]: https://golang.org/dl/
[2]: https://www.ruby-lang.org/en/ [2]: https://github.com/caddyserver/caddydev
[3]: https://github.com/caddyserver/caddydev [3]: https://github.com/jteeuwen/go-bindata
[4]: http://sass-lang.com/install [4]: https://nodejs.org
[5]: https://github.com/jteeuwen/go-bindata
[6]: https://nodejs.org
[7]: http://gruntjs.com/