Number of watchers on Github | 24115 |
Number of open issues | 210 |
Average time to close an issue | about 17 hours |
Main language | Go |
Average time to merge a PR | 2 days |
Open pull requests | 65+ |
Closed pull requests | 40+ |
Last commit | 11 months ago |
Repo Created | over 5 years ago |
Repo Last Updated | 11 months ago |
Size | 52.8 MB |
Homepage | https://gohugo.io |
Organization / Author | gohugoio |
Latest Release | v0.37.1 |
Contributors | 455 |
Page Updated | 2018-03-17 |
Do you use hugo? Leave a review! | |
View open issues (210) | |
View on github | |
Fresh, new opensource launches πππ | |
Trendy new open source projects in your inbox!
View examples
|
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
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 dont 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.
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 Hugo Documentation.
If you want to use Hugo as your site generator, simply install the Hugo binaries. The Hugo binaries have no external dependencies.
To contribute to the Hugo source code or documentation, you should fork the Hugo GitHub project and clone it to your local machine.
Finally, you can install the Hugo source code with go
, build the binaries yourself, and run Hugo that way.
Building the binaries is an easy task for an experienced go
getter.
Use the installation instructions in the Hugo documentation.
Add Hugo and its package dependencies to your go src
directory.
go get -v github.com/gohugoio/hugo
Once the get
completes, you should find your new hugo
(or hugo.exe
) executable sitting inside $GOPATH/bin/
.
To update Hugos dependencies, use go get
with the -u
option.
go get -u -v github.com/gohugoio/hugo
The Hugo documentation now lives in its own repository, see https://github.com/gohugoio/hugoDocs. But we do keep a version of that documentation as a git subtree
in this repository. To build the sub folder /docs
as a Hugo site, you need to clone this repo:
git clone git@github.com:gohugoio/hugo.git
For a complete guide to contributing to Hugo, see the Contribution Guide.
We welcome contributions to Hugo of any kind including documentation, themes, organization, tutorials, blog posts, bug reports, issues, feature requests, feature implementations, pull requests, answering questions on the forum, helping to manage issues, etc.
The Hugo community and maintainers are very active and helpful, and the project benefits greatly from this activity.
We have an active discussion forum where users and developers can ask questions. Please don't use the GitHub issue tracker to ask questions.
If you believe you have found a defect in Hugo or its documentation, use
the GitHub issue tracker to report the problem to the Hugo maintainers.
If you're not sure if it's a bug or not, start by asking in the discussion forum.
When reporting the issue, please provide the version of Hugo in use (hugo version
).
The Hugo project welcomes all contributors and contributions regardless of skill or experience level. If you are interested in helping with the project, we will help you with your contribution. Hugo is a very active project with many contributions happening daily.
Because we want to create the best possible product for our users and the best contribution experience for our developers, we have a set of guidelines which ensure that all contributions are acceptable. The guidelines are not intended as a filter or barrier to participation. If you are unfamiliar with the contribution process, the Hugo team will help you and teach you how to bring your contribution in accordance with the guidelines.
For a complete guide to contributing code to Hugo, see the Contribution Guide.
This is a bug-fix release with a one important fix:
Image content such as SVG
cannot be scaled with the built-in image processing methods, but it should still be possible to use them as page resources. This was a regression in Hugo 0.37
and is now fixed. ba94abbf @bep #4455
Automated with GoReleaser Built with go version go1.10 linux/amd64
The main item in Hugo 0.37
is that we now properly preserve the colour palette when processing PNG
images. We got reports from users experiencing their PNG
images getting bigger in file size when scaled down. Now, if you, as an example, start out with a carefully chosen 8 bit colour palette (i.e. PNG-8
), this is now what you will end up with. A special thanks to @aitva for doing the investigative work finding a proper fix for this issue.
This release represents 40 contributions by 5 contributors to the main Hugo code base.
@bep leads the Hugo development with a significant amount of contributions, but also a big shoutout to @vassudanagunta, @kaushalmodi, and @curttimson for their ongoing contributions.
And as always a big thanks to @digitalcraftsman for his relentless work on keeping the documentation and the themes site in pristine condition.
Many have also been busy writing and fixing the documentation in hugoDocs, which has received 24 contributions by 8 contributors. A special thanks to @bep, @4RU, @kaushalmodi, and @mitchchn for their work on the documentation site.
Hugo now has:
YAML
map keys to string. See #4393 for more information. You will get a WARNING
in the console if you are touched by this.PNG
processing, and have incremented the version numbers on the URL for the processed PNG
image. This will just work, but you may want to run hugo --gc
to clean up some old stale images in the resource cache.Floyd-Steinberg
dithering for PNGs 13ea1e7c @bep #4453
ge
, le
etc. work with the Hugo Version number 0602135f @bep #4443
YAML
array data files 1fa24177 @vassudanagunta #3890
targetand
relparameters to figure shortcode 2e95ec68 @kaushalmodi
property, nottwitter:image:src" 76d38d5e @kaushalmodi
GitInfo
lookup on error e9750d83 @bep URL
for sections with URL in front matter 9f740b37 @bep #4415
YAML
maps key type 16a5c745 @dmgawel #2441
ERROR
on missing baseURL 55bd46a6 @bep #4397
Automated with GoReleaser Built with go version go1.10 linux/amd64
This release fixes a multi-thread issue when reprocessing and reusing images across pages. When doing something like this with the same image from a partial used in, say, both the home page and the single page:
{{ with $img }}
{{ $big := .Fill "1024x512 top" }}
{{ $small := $big.Resize "512x" }}
{{ end }}
There would be timing issues making Hugo in some cases trying to process the same image twice at the same time.
You would experience errors of type:
png: invalid format: not enough pixel data
This commit fixes that by adding a mutex per image. This should also improve the performance, sligthly, as it avoids duplicate work.
The current workaround before this fix is to always operate on the original:
{{ with $img }}
{{ $big := .Fill "1024x512 top" }}
{{ $small := .Fill "512x256 top" }}
{{ end }}
This error was rare (no reports on GitHub or the discussion forum), but very hard to debug for the end user.
Automated with GoReleaser Built with go version go1.9.4 linux/amd64