hugo-boilerplate

Boilerplate to start fast with Hugo.

Demo

Screenshot

Requirements

• git
• hugo
• node
• npm

Installation

# clone hugo-boilerplate into new project folder
git clone https://github.com/enten/hugo-boilerplate awesome-site

# remove origin repository (enten/hugo-boilerplate)
cd awesome-site
git remote remove origin

# start hugo development server
npm run server

Watching for changes in /home/steven/code/hugo-boilerplate/{data,content,layouts,static,themes/hyde-y}
Serving pages from /home/steven/code/hugo-boilerplate/public
Web Server is available at http://127.0.0.1:1313/hugo-boilerplate/
Press Ctrl+C to stop

Deployment

GitHub Pages

cd awesome-site

# check hugo configuration
vi config.toml

# configure origin repository
git remote add origin https://github.com/<USERNAME>/<REPONAME>

# run deployment task
npm run deploy:gh

Warnings :

• baseurl in config.toml will be replace by the correct URL (http://username.github.io/reponame)
• static site is rebuilt in public/ folder when deploy:gh is fired

FTP

cd awesome-site

# check hugo configuration
vi config.toml

# create ftp configuration
echo '{
  "host": "ftp.example.com",
  "port": 21,
  "remote": "/www",
  "user": "*****",
  "pass": "*****"
}' > ftp-config.json

# edit ftp configuration
vi ftp-config.json

# run deployment task
npm run deploy

Warnings :

• remote folder must exists on the host
• BUG: several attempts are needed to deploy all files

License

Open sourced under the MIT license.