filebrowser/README.md

2.4 KiB

caddy-cms

Build Documentation

Powerful and easy static site generator with admin interface. By default it uses Hugo (and you don't need to install it separately) but you can use whatever you want.

Build it from source

If you want to try caddy-cms plugin (and improve it maybe), you'll have to install some tools.

If you want to go deeper and make changes in front-end assets like JavaScript or CSS, you'll need some more tools.

Run it

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-cms. 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 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-cms} with the location of your clone.

caddydev --source {caddy-cms} 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-cms clone. Then, run grunt watch.