The world’s fastest framework for building websites.
Find a file
Rahul Bansal 6e15f652bd Added yaml menu example
Added yaml menu example, matching with existing toml example. Also added link to sitewide config page.
2014-08-18 11:30:00 -04:00
commands it's/its 2014-07-26 23:43:21 -07:00
create Updating Convert to handle dates properly for yaml and json 2014-05-29 18:45:19 -04:00
docs Added yaml menu example 2014-08-18 11:30:00 -04:00
examples Add Sitemap documentation content 2014-05-09 23:11:48 -04:00
helpers new site works in an empty directory now 2014-05-19 09:16:40 -04:00
hugolib allow site to be built with empty content 2014-06-30 15:28:18 -04:00
livereload Fixing bug with Live Reload where it broadcast instead of sending the handshake 2014-05-27 18:35:12 -04:00
parser Adding new commands (new site [path], new theme [name]) 2014-05-08 18:30:58 -04:00
source Don't process dotfiles 2014-04-26 23:17:54 -06:00
target moving writeToDisk to helpers to make it more accessible 2014-05-01 13:13:11 -04:00
transform Fixed #301. LiveReload works on any port now. 2014-05-28 19:01:24 -04:00
utils report errors 2014-06-30 15:26:40 -04:00
watcher gofmt all go code 2014-01-29 18:03:35 -05:00
.gitignore Ignore content files ending in ~ 2014-02-28 23:23:59 -05:00
.travis.yml Reorganization of helpers. Centralized Url/Path logic. Fixed #175. 2014-02-27 20:33:18 -05:00
baseline.txt Adding baseline 2013-11-05 22:51:40 +00:00
LICENSE.md adding hugo 2013-07-04 11:32:55 -04:00
main.go Adding support for logging & verbose logging. Consolidation of error handling. Integration of jWalterWeatherman library. Fixed #137 2014-03-31 13:23:34 -04:00
README.md change golang to go 2014-03-24 14:34:41 -04:00
wercker.yml Create wercker.yml 2014-01-15 11:02:24 -05:00

Hugo

A Fast and Flexible Static Site Generator built with love by spf13 and friends in Go.

Build Status wercker status

Overview

Hugo is a static site generator written in Go. It is optimized for speed, easy use and configurability. Hugo takes a directory with content and templates and renders them into a full html website.

Hugo makes use of markdown files with front matter for meta data.

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.

Complete documentation is available at Hugo Documentation.

Getting Started

Installing Hugo

Hugo is written in Go with support for Windows, Linux, FreeBSD and OSX.

The latest release can be found at hugo releases. We currently build for Windows, Linux, FreeBSD and OS X for x64 and 386 architectures.

Installing Hugo (binary)

Installation is very easy. Simply download the appropriate version for your platform from 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.

Ideally you should install it somewhere in your path for easy use. /usr/local/bin is the most probable location.

The Hugo executable has no external dependencies.

Installing from source

Dependencies

  • Git
  • Go 1.1+
  • Mercurial
  • Bazaar

Clone locally (for contributors):

git clone https://github.com/spf13/hugo
cd hugo
go get

Because go expects all of your libraries to be found in either $GOROOT or $GOPATH, 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

Get directly from Github:

If you only want to build from source, it's even easier.

go get github.com/spf13/hugo

Building Hugo

cd /path/to/hugo
go build -o hugo main.go
mv hugo /usr/local/bin/

Running Hugo

cd /path/to/hugo
go install github.com/spf13/hugo/hugolib
go run main.go

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.

Complete documentation is available at Hugo Documentation.

Analytics Bitdeli Badge