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.
214 commits 141 branches 301 tags 201 MiB
Go 95.9%
JavaScript 3.1%
HTML 0.9%
Find a file
Noah Campbell 311e102223 Allow non-markdown content in content directory 
Allow content that is not markdown and does not need to be rendered to
exists in the content directory.  Currently any valid html or xml
document can exist.  Templates are applied to these documents as well.
If you need to have content that doesn't have templates or AbsUrlify
like operations, then continue to put this content in static and it will
be copied over.
2013-09-18 14:21:27 -07:00
docs Fix alias documentation. 2013-09-13 16:06:39 -07:00
hugolib Allow non-markdown content in content directory 2013-09-18 14:21:27 -07:00
parser Add IsRenderable to Page 2013-09-18 10:17:43 -07:00
source Normalize paths within hugo 2013-09-12 10:48:59 -07:00
target Add /index.html to unadorned alias paths 2013-09-13 14:51:28 -07:00
template Move alias logic to target module 2013-09-12 21:20:00 -07:00
transform Fix parsing edge case of frontmatter 2013-09-18 09:15:46 -07:00
.gitignore Update .gitignore to ignore *.swo files 2013-08-23 14:57:21 -07:00
.travis.yml Include building hugo docs as part of test. 2013-09-01 20:03:10 -07:00
LICENSE.md adding hugo 2013-07-04 11:32:55 -04:00
main.go Return an error (other than 0) when ./hugo fails 2013-09-01 11:39:32 -07:00
README.md Add support for continuous testing. 2013-08-09 18:34:51 -07:00

README.md

Hugo

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

Build Status

Overview

Hugo is a static site generator written in GoLang. 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 GoLang 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 executible 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/hugolibs
go run main.go

Complete documentation is available at Hugo Documentation.