github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity
The world’s fastest framework for building websites.
696 commits 141 branches 301 tags 201 MiB
Go 95.9%
JavaScript 3.1%
HTML 0.9%
Find a file
Tatsushi Demachi 5e28606b84 Add sort and grouping functions for publish date and param of Page 
`GroupBy` is modified to allow it to receive a method name argument for
example `Type` as its first argument. It is only allowed to call with
a method which takes no arguments and returns a result or a pair of
a result and an error.

The functions discussed at #443 are also added

- `ByPublishDate`: Order contents by `PublishDate` front matter variable
- `GroupByPublishDate(format, order)`: Group contents by `PublishDate`
  front matter variable formatted in string like `GroupByDate`
- `GroupByParam(key, order)`: Group contents by `Param` front matter
  variable specified by `key` argument
- `GroupByParamDate(key, format, order)`: Group contents by `Param`
  front matter variable specified by `key` argument and formatted in
  string like `GroupByDate`. It's effective against `time.Time` type
  front matter variable
2014-11-01 22:41:04 -04:00
commands fixed server reporting Web Server is available at https://localhost:1313 when server always serve http 2014-11-01 22:33:43 -04:00
create Migrating Hugo to Afero for filesystem calls. 2014-11-01 11:57:29 -04:00
docs Add sort and grouping functions for publish date and param of Page 2014-11-01 22:41:04 -04:00
examples Switch to new hompage 2014-10-02 13:39:59 -04:00
helpers Migrating Hugo to Afero for filesystem calls. 2014-11-01 11:57:29 -04:00
hugofs Migrating Hugo to Afero for filesystem calls. 2014-11-01 11:57:29 -04:00
hugolib Add sort and grouping functions for publish date and param of Page 2014-11-01 22:41:04 -04:00
livereload Set Content-Type for livereload.js 2014-10-15 12:45:29 -04:00
parser switch to new location of goyaml 2014-08-18 11:31:55 -04:00
source Big refactor of how source files are used. Also added default destination extension option. 2014-10-16 20:20:09 -04:00
target Migrating Hugo to Afero for filesystem calls. 2014-11-01 11:57:29 -04:00
transform Fixed #301. LiveReload works on any port now. 2014-05-28 19:01:24 -04:00
utils More error messages at syncing static contents 2014-09-08 11:57:06 -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 Bumping Travis to test Go 1.2 & tip (1.3) 2014-08-25 15:18:53 -04: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 More proofreading and minor revisions to Hugo docs 2014-09-08 11:41:10 -04:00
README.md Switch to new hompage 2014-10-02 13:39:59 -04:00
wercker.yml Create wercker.yml 2014-01-15 11:02:24 -05:00

README.md

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 OS X.

The latest release can be found at hugo releases. We currently build for Windows, Linux, FreeBSD and OS X for x64 and i386 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 -v 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