hugo/README.md

131 lines
5.4 KiB
Markdown
Raw Normal View History

2013-07-04 15:34:22 +00:00
# Hugo
A Fast and Flexible Static Site Generator built with love by [spf13](http://spf13.com)
and [friends](http://github.com/spf13/hugo/graphs/contributors) in Go.
2013-07-04 15:34:22 +00:00
[![Build Status](https://travis-ci.org/spf13/hugo.png)](https://travis-ci.org/spf13/hugo)
2014-01-15 16:06:41 +00:00
[![wercker status](https://app.wercker.com/status/1a0de7d703ce3b80527f00f675e1eb32 "wercker status")](https://app.wercker.com/project/bykey/1a0de7d703ce3b80527f00f675e1eb32)
[![Build status](https://ci.appveyor.com/api/projects/status/n2mo912b8s2505e8/branch/master?svg=true)](https://ci.appveyor.com/project/spf13/hugo/branch/master)
2013-07-04 15:34:22 +00:00
## Overview
2014-03-24 11:19:25 +00:00
Hugo is a static site generator written in Go. It is optimized for
2013-07-04 15:34:22 +00:00
speed, easy use and configurability. Hugo takes a directory with content and
templates and renders them into a full HTML website.
2013-07-04 15:34:22 +00:00
Hugo makes use of Markdown files with front matter for meta data.
2013-07-04 15:34:22 +00:00
A typical website of moderate size can be
rendered in a fraction of a second. A good rule of thumb is that Hugo
takes around 1 millisecond for each piece of content.
It is written to work well with any
kind of website including blogs, tumbles and docs.
2013-07-04 15:34:22 +00:00
2014-09-27 07:35:42 +00:00
**Complete documentation is available at [Hugo Documentation](http://gohugo.io).**
2013-07-04 15:34:22 +00:00
# Getting Started
## Installing Hugo
Hugo is written in Go with support for Windows, Linux, FreeBSD and OS X.
The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases).
We currently build for Windows, Linux, FreeBSD and OS X for x64
and i386 architectures.
2013-07-24 15:47:58 +00:00
### Installing Hugo (binary)
2013-07-24 15:43:23 +00:00
2013-07-04 15:34:22 +00:00
Installation is very easy. Simply download the appropriate version for your
platform from [Hugo Releases](https://github.com/spf13/hugo/releases).
Once downloaded, it can be run from anywhere. You don't need to install
it into a global location. This works well for shared hosts and other systems
where you don't have a privileged account.
2013-07-04 15:34:22 +00:00
Ideally, you should install it somewhere in your path for easy use. `/usr/local/bin`
2013-07-04 15:34:22 +00:00
is the most probable location.
2014-03-19 12:22:06 +00:00
*The Hugo executable has no external dependencies.*
2013-07-04 15:34:22 +00:00
2013-07-24 15:47:58 +00:00
### Installing from source
2013-07-04 17:03:16 +00:00
2013-07-24 15:47:58 +00:00
#### Dependencies
* Git
* Go 1.1+ (Go 1.4+ on Windows, see Go [Issue #8090](https://code.google.com/p/go/issues/detail?id=8090))
* Mercurial
* Bazaar
2013-07-24 15:47:58 +00:00
#### Clone locally (for contributors):
2013-07-04 17:03:16 +00:00
git clone https://github.com/spf13/hugo
cd hugo
go get
2013-07-04 17:03:16 +00:00
Because Go expects all of your libraries to be found in either `$GOROOT` or `$GOPATH`,
2013-07-24 15:43:23 +00:00
it's helpful to symlink the project to one of the following paths:
* `ln -s /path/to/your/hugo $GOPATH/src/github.com/spf13/hugo`
* `ln -s /path/to/your/hugo $GOROOT/src/pkg/github.com/spf13/hugo`
2013-07-24 15:43:23 +00:00
#### Get directly from GitHub:
2013-07-24 15:43:23 +00:00
If you only want to build from source, it's even easier.
go get -v github.com/spf13/hugo
2013-07-04 17:03:16 +00:00
2013-07-24 15:47:58 +00:00
#### Building Hugo
2013-07-24 15:43:23 +00:00
cd /path/to/hugo
go build -o hugo main.go
2013-07-24 15:43:23 +00:00
mv hugo /usr/local/bin/
2013-07-04 17:03:16 +00:00
##### Adding compile information to Hugo
When Hugo is built using the above steps, the `version` sub-command will include the `mdate` of the Hugo executable, similar to the following:
Hugo Static Site Generator v0.13-DEV buildDate: 2014-12-24T04:46:03-07:00
Instead, it is possible to have the `version` sub-command return information about the git commit used and time of compilation using `build` flags.
To do this, replace the `go build` command with the following *(replace `/path/to/hugo` with the actual path)*:
go build -ldflags "-X /path/to/hugo/hugolib.CommitHash `git rev-parse --short HEAD 2>/dev/null` -X github.com/spf13/hugo/hugolib.BuildDate `date +%FT%T%z`"
This will result in `hugo version` output that looks similar to:
Hugo Static Site Generator v0.13-DEV-8042E77 buildDate: 2014-12-25T03:25:57-07:00
The format of the date is configurable via the `Params.DateFormat` setting. `DateFormat` is a string value representing the Go time layout that should be used to format the date output. If `Params.DateFormat` is not set, `time.RFC3339` will be used as the default format. See Go's ["time" package documentation](http://golang.org/pkg/time/#pkg-constants) for more information.
Configuration setting using config.yaml as example:
Params:
DateFormat: "2006-01-02"
Will result in:
Hugo Static Site Generator v0.13-DEV buildDate: 2014-10-16
Hugo Static Site Generator v0.13-DEV-24BBFE7 buildDate: 2014-10-16
#### Running Hugo
2013-07-04 15:34:22 +00:00
cd /path/to/hugo
2014-03-09 03:17:17 +00:00
go install github.com/spf13/hugo/hugolib
go run main.go
2013-07-04 15:34:22 +00:00
2013-12-08 04:48:17 +00:00
#### Contribution Guidelines
We welcome your contributions. To make the process as seamless as possible, we ask for the following:
* Go ahead and fork the project and make your changes. We encourage pull requests to discuss code changes.
* When you're ready to create a pull request, be sure to:
* Have test cases for the new code. If you have questions about how to do it, please ask in your pull request.
* Run `go fmt`
* Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request.
* Make sure `go test ./...` passes, and `go build` completes. Our Travis CI loop will catch most things that are missing. The exception: Windows. We run on Windows from time to time, but if you have access, please check on a Windows machine too.
2013-12-08 04:48:17 +00:00
2014-09-27 07:35:42 +00:00
**Complete documentation is available at [Hugo Documentation](http://gohugo.io).**
2014-01-03 17:58:09 +00:00
[![Analytics](https://ga-beacon.appspot.com/UA-7131036-6/hugo/readme)](https://github.com/igrigorik/ga-beacon)
[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/spf13/hugo/trend.png)](https://bitdeli.com/free "Bitdeli Badge")