heroku-buildpack-hugo

by jaketrent

GitHub Readme.md

Heroku buildpack: Hugo

This is a Heroku buildpack for sites powered by Hugo. It uses the latest stable version of Hugo.

Usage

Create a Heroku application using this buildpack:

$ heroku create --buildpack https://github.com/roperzh/heroku-buildpack-hugo.git

or configure your existent application:

$ heroku config:add BUILDPACK_URL="https://github.com/roperzh/heroku-buildpack-hugo.git"

Then simply git push to heroku and open your application!

$ git push heroku master
$ heroku open

Legacy Compatibility

For most pages this buildpack should work just fine. If, however, you're unable to deploy using this new version of the buildpack, you can get your app working again by locking it to the previous version:

heroku config:set BUILDPACK_URL=https://github.com/roperzh/heroku-buildpack-hugo#v0.18.1
git commit -am "Empty commit" --allow-empty
git push heroku master

Using themes

This buildpack provides a simple api to use custom themes, just add a .hugotheme file in the root of your application with the url of your theme.

Example

To fetch the great hyde theme:

https://github.com/spf13/hyde.git

Here is an example application, and here is the code.

Alternative method

If you don't like the idea of a .hugotheme file, you can simply manage your themes with git submodules. Heroku will take care to fetch all the submodules in your project.

Important notes

Don't forget to configure your hugo baseurl with the url of your application, using https:// not http://

Contributing

1- Fork it

2- Create your feature branch (git checkout -b my-new-feature)

3- Commit your changes (git commit -am 'Add some feature')

4- Push to the branch (git push origin my-new-feature)

5- Create new Pull Request

License

The MIT License (MIT)

Copyright (c) 2015 Roberto Dip

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.