Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/roperzh/heroku-buildpack-hugo

Heroku buildpack for Hugo, the static site generator - https://github.com/spf13/hugo
https://github.com/roperzh/heroku-buildpack-hugo

buildpack heroku heroku-buildpack hugo shell

Last synced: 4 days ago
JSON representation

Heroku buildpack for Hugo, the static site generator - https://github.com/spf13/hugo

Host: GitHub
URL: https://github.com/roperzh/heroku-buildpack-hugo
Owner: roperzh
Created: 2014-08-10T20:27:17.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-07-05T00:55:18.000Z (6 months ago)
Last Synced: 2024-12-14T19:05:42.558Z (11 days ago)
Topics: buildpack, heroku, heroku-buildpack, hugo, shell
Language: Shell
Size: 17.6 KB
Stars: 82
Watchers: 2
Forks: 117
Open Issues: 15
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

Heroku buildpack: Hugo
===

This is a [Heroku buildpack](https://devcenter.heroku.com/articles/buildpacks)
for sites powered by [Hugo](https://github.com/spf13/hugo).
It uses the latest stable version of Hugo.

Usage
===

Create a Heroku application using this buildpack:

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

or configure your existent application:

```bash
$ heroku buildpacks:set BUILDPACK_URL="https://github.com/roperzh/heroku-buildpack-hugo.git"
```

Optionally, define a `HUGO_VERSION` Config Var to specify the Hugo version you wish to use:

```bash
$ heroku config:set HUGO_VERSION=0.25
```

Then simply git push to heroku and open your application!

```bash
$ git push heroku master
$ heroku open
```

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](https://github.com/spf13/hyde.git) theme:

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

[Here](http://immense-hollows-6319.herokuapp.com/) is an example application,
and [here](https://github.com/roperzh/example-heroku-buildpack-hugo) 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](http://git-scm.com/book/en/Git-Tools-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)

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.