headgeekette/hugo repository overview

A Fast and Flexible Static Site Generator built with love by bep⁠, spf13⁠ and friends⁠ in [Go][].

Website⁠ | Forum⁠ | Developer Chat (no support)⁠ | Documentation⁠ | Installation Guide⁠ | Contribution Guide⁠ | Twitter⁠

⁠Overview

Hugo is a static HTML and CSS website generator written in Go⁠. It is optimized for speed, ease of use, and configurability. Hugo takes a directory with content and templates and renders them into a full HTML website.

Hugo relies on Markdown files with front matter for metadata, and you can run Hugo from any directory. This works well for shared hosts and other systems where you don’t have a privileged account.

Hugo renders a typical website of moderate size in a fraction of a second. A good rule of thumb is that each piece of content renders in around 1 millisecond.

Hugo is designed to work well for any kind of website including blogs, tumbles, and docs.

⁠Supported Architectures

Currently, we provide pre-built Hugo binaries for Windows, Linux, FreeBSD, NetBSD, macOS (Darwin), and Android⁠ for x64, i386 and ARM architectures.

Hugo may also be compiled from source wherever the Go compiler tool chain can run, e.g. for other operating systems including DragonFly BSD, OpenBSD, Plan 9, and Solaris.

Complete documentation is available at the Hugo website.

⁠About This Container

This was created to be used to run on Visual Studio Code as part of the IDE's Remote Containers development feature. But it should not stop you from using this for anything else.

This container uses the extended version of Hugo.

⁠Using This Container

To generate a new site:

docker run -it --rm -v $PWD:/source headgeekette/hugo new site ${NAME_OF_SITE}

To generate a new post:

docker run --rm -v $PWD:/source headgeekette/hugo new ${NAME_OF_POST}

You might have to change ownership and group in order to edit the necessary files after creating a new site and/or new post.

When running as a server, do not forget to specify the base url and bind to 0.0.0.0.

docker run --rm -p 1313:1313 -v `pwd`:/source headgeekette/hugo \
     server \
    -b http://localhost:1313 --bind=0.0.0.0