pax_global_header00006660000000000000000000000064130312420110014475gustar00rootroot0000000000000052 comment=dab1303c1847603f0c36719d1b865cff1001c6ac hugo-0.18.1/000077500000000000000000000000001303124201100125265ustar00rootroot00000000000000hugo-0.18.1/.gitignore000066400000000000000000000002221303124201100145120ustar00rootroot00000000000000hugo docs/public* /.idea hugo.exe *.test *.prof nohup.out cover.out *.swp *.swo .DS_Store *~ vendor/*/ *.bench coverage*.out GoBuildshugo-0.18.1/.goxc.json000066400000000000000000000004021303124201100144330ustar00rootroot00000000000000{ "ArtifactsDest": "GoBuilds/", "OutPath": "{{.Dest}}{{.PS}}{{.AppName}}{{.PS}}{{.Version}}{{.PS}}{{.AppName}}_{{.Version}}_{{.Os}}_{{.Arch}}{{.Ext}}", "BuildConstraints": "linux windows darwin freebsd netbsd openbsd dragonfly", "ConfigVersion": "0.9" } hugo-0.18.1/.mailmap000066400000000000000000000002421303124201100141450ustar00rootroot00000000000000spf13 Steve Francia bep Bjørn Erik Pedersen hugo-0.18.1/.travis.yml000066400000000000000000000007541303124201100146450ustar00rootroot00000000000000language: go sudo: required go: - 1.6.3 - 1.7.3 - tip os: - linux - osx matrix: allow_failures: - go: tip fast_finish: true install: - make govendor script: - make check # Test 64-bit alignment on 32-bit builds - env GOARCH=386 make test - go build -race - ./hugo -s docs/ - ./hugo --renderToMemory -s docs/ before_install: # gem install must be run with sudo on OSX - sudo gem install asciidoctor | gem install asciidoctor - sudo pip install docutils hugo-0.18.1/CONTRIBUTING.md000066400000000000000000000152141303124201100147620ustar00rootroot00000000000000# Contributing to Hugo 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 created a [step by step guide](https://gohugo.io/tutorials/how-to-contribute-to-hugo/) if you're unfamiliar with GitHub or contributing to open source projects in general. [![Throughput Graph](https://graphs.waffle.io/spf13/hugo/throughput.svg)](https://waffle.io/spf13/hugo/metrics) ## Table of Contents * [Asking Support Questions](#asking-support-questions) * [Reporting Issues](#reporting-issues) * [Submitting Patches](#submitting-patches) * [Code Contribution Guidelines](#code-contribution-guidelines) * [Git Commit Message Guidelines](#git-commit-message-guidelines) * [Using Git Remotes](#using-git-remotes) * [Build Hugo with Your Changes](#build-hugo-with-your-changes) * [Add Compile Information to Hugo](#add-compile-information-to-hugo) ## Asking Support Questions We have an active [discussion forum](http://discuss.gohugo.io) where users and developers can ask questions. Please don't use the Github issue tracker to ask questions. ## Reporting Issues If you believe you have found a defect in Hugo or its documentation, use the Github [issue tracker](https://github.com/spf13/hugo/issues) 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](http://discuss.gohugo.io). When reporting the issue, please provide the version of Hugo in use (`hugo version`) and your operating system. ## Submitting Patches 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. ### Code Contribution Guidelines To make the contribution 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 allow for review and discussion of code changes. * When you’re ready to create a pull request, be sure to: * Sign the [CLA](https://cla-assistant.io/spf13/hugo). * Have test cases for the new code. If you have questions about how to do this, please ask in your pull request. * Run `go fmt`. * Add documentation if you are adding new features or changing functionality. The docs site lives in `/docs`. * Squash your commits into a single commit. `git rebase -i`. It’s okay to force update your pull request with `git push -f`. * Make sure `go test ./...` passes, and `go build` completes. [Travis CI](https://travis-ci.org/spf13/hugo) (Linux and OS X) and [AppVeyor](https://ci.appveyor.com/project/spf13/hugo/branch/master) (Windows) will catch most things that are missing. * Follow the **Git Commit Message Guidelines** below. ### Git Commit Message Guidelines This [blog article](http://chris.beams.io/posts/git-commit/) is a good resource for learning how to write good commit messages, the most important part being that each commit message should have a title/subject in imperative mood starting with a capital letter and no trailing period: *"Return error on wrong use of the Paginator"*, **NOT** *"returning some error."* Also, if your commit references one or more GitHub issues, always end your commit message body with *See #1234* or *Fixes #1234*. Replace *1234* with the GitHub issue ID. The last example will close the issue when the commit is merged into *master*. Sometimes it makes sense to prefix the commit message with the packagename (or docs folder) all lowercased ending with a colon. That is fine, but the rest of the rules above apply. So it is "tpl: Add emojify template func", not "tpl: add emojify template func.", and "docs: Document emoji", not "doc: document emoji." Please consider to use a short and descriptive branch name, e.g. **NOT** "patch-1". It's very common but creates a naming conflict each time when a submission is pulled for a review. An example: ```text tpl: Add custom index function Add a custom index template function that deviates from the stdlib simply by not returning an "index out of range" error if an array, slice or string index is out of range. Instead, we just return nil values. This should help make the new default function more useful for Hugo users. Fixes #1949 ``` ### Using Git Remotes Due to the way Go handles package imports, the best approach for working on a Hugo fork is to use Git Remotes. Here's a simple walk-through for getting started: 1. Get the latest Hugo sources: ``` go get -u -t github.com/spf13/hugo/... ``` 1. Change to the Hugo source directory: ``` cd $GOPATH/src/github.com/spf13/hugo ``` 1. Create a new branch for your changes (the branch name is arbitrary): ``` git checkout -b iss1234 ``` 1. After making your changes, commit them to your new branch: ``` git commit -a -v ``` 1. Fork Hugo in Github. 1. Add your fork as a new remote (the remote name, "fork" in this example, is arbitrary): ``` git remote add fork git://github.com/USERNAME/hugo.git ``` 1. Push the changes to your new remote: ``` git push --set-upstream fork iss1234 ``` 1. You're now ready to submit a PR based upon the new branch in your forked repository. ### Build Hugo with Your Changes ```bash cd $GOPATH/src/github.com/spf13/hugo go build mv hugo /usr/local/bin/ ``` ### Add Compile Information to Hugo To add compile information to Hugo, replace the `go build` command with the following *(replace `/path/to/hugo` with the actual path)*: go build -ldflags "-X /path/to/hugo/hugolib.CommitHash=`git rev-parse --short HEAD 2>/dev/null` -X github.com/spf13/hugo/hugolib.BuildDate=`date +%FT%T%z`" This will result in `hugo version` output that looks similar to: Hugo Static Site Generator v0.13-DEV-8042E77 buildDate: 2014-12-25T03:25:57-07:00 Alternatively, just run `make` — all the “magic” above is already in the `Makefile`. :wink: hugo-0.18.1/Dockerfile000066400000000000000000000033141303124201100145210ustar00rootroot00000000000000FROM golang:1.6.2 MAINTAINER Sven Dowideit ENV GOPATH /go ENV USER root # pre-install known dependencies before the source, so we don't redownload them whenever the source changes RUN go get github.com/stretchr/testify/assert \ && go get github.com/kyokomi/emoji \ && go get github.com/bep/inflect \ && go get github.com/BurntSushi/toml \ && go get github.com/PuerkitoBio/purell \ && go get github.com/PuerkitoBio/urlesc \ && go get github.com/dchest/cssmin \ && go get github.com/eknkc/amber \ && go get github.com/gorilla/websocket \ && go get github.com/kardianos/osext \ && go get github.com/miekg/mmark \ && go get github.com/mitchellh/mapstructure \ && go get github.com/russross/blackfriday \ && go get github.com/shurcooL/sanitized_anchor_name \ && go get github.com/spf13/afero \ && go get github.com/spf13/cast \ && go get github.com/spf13/jwalterweatherman \ && go get github.com/spf13/cobra \ && go get github.com/cpuguy83/go-md2man \ && go get github.com/inconshreveable/mousetrap \ && go get github.com/spf13/pflag \ && go get github.com/spf13/fsync \ && go get github.com/spf13/viper \ && go get github.com/kr/pretty \ && go get github.com/kr/text \ && go get github.com/magiconair/properties \ && go get golang.org/x/text/transform \ && go get golang.org/x/text/unicode/norm \ && go get github.com/yosssi/ace \ && go get github.com/spf13/nitro \ && go get github.com/fortytw2/leaktest \ && go get github.com/fsnotify/fsnotify COPY . /go/src/github.com/spf13/hugo RUN go get -d -v github.com/spf13/hugo RUN go install github.com/spf13/hugo WORKDIR /go/src/github.com/spf13/hugo RUN go get -d -v RUN go build -o hugo main.go RUN go test github.com/spf13/hugo/... hugo-0.18.1/LICENSE.md000066400000000000000000000243601303124201100141370ustar00rootroot00000000000000Apache License ============== _Version 2.0, January 2004_ _<>_ ### Terms and Conditions for use, reproduction, and distribution #### 1. Definitions “License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. “Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. “Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, “control” means **(i)** the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the outstanding shares, or **(iii)** beneficial ownership of such entity. “You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License. “Source” form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. “Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. “Work” shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). “Derivative Works” shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. “Contribution” shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as “Not a Contribution.” “Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. #### 2. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. #### 3. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. #### 4. Redistribution You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: * **(a)** You must give any other recipients of the Work or Derivative Works a copy of this License; and * **(b)** You must cause any modified files to carry prominent notices stating that You changed the files; and * **(c)** You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and * **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. #### 5. Submission of Contributions Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. #### 6. Trademarks This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. #### 7. Disclaimer of Warranty Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. #### 8. Limitation of Liability In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. #### 9. Accepting Warranty or Additional Liability While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. _END OF TERMS AND CONDITIONS_ ### APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets `[]` replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same “printed page” as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. hugo-0.18.1/Makefile000066400000000000000000000040761303124201100141750ustar00rootroot00000000000000 # Adds build information from git repo # # as suggested by tatsushid in # https://github.com/spf13/hugo/issues/540 COMMIT_HASH=`git rev-parse --short HEAD 2>/dev/null` BUILD_DATE=`date +%FT%T%z` LDFLAGS=-ldflags "-X github.com/spf13/hugo/hugolib.CommitHash=${COMMIT_HASH} -X github.com/spf13/hugo/hugolib.BuildDate=${BUILD_DATE}" PACKAGES = $(shell govendor list -no-status +local | sed 's/github.com.spf13.hugo/./') all: gitinfo install: install-gitinfo help: echo ${COMMIT_HASH} echo ${BUILD_DATE} gitinfo: go build ${LDFLAGS} -o hugo main.go install-gitinfo: go install ${LDFLAGS} ./... no-git-info: go build -o hugo main.go docker: docker build -t hugo . docker rm -f hugo-build || true docker run --name hugo-build hugo ls /go/bin docker cp hugo-build:/go/bin/hugo . docker rm hugo-build govendor: go get -u github.com/kardianos/govendor go install github.com/kardianos/govendor govendor sync github.com/spf13/hugo check: fmt vet test test-race cyclo: @for d in `govendor list -no-status +local | sed 's/github.com.spf13.hugo/./'` ; do \ if [ "`gocyclo -over 20 $$d | tee /dev/stderr`" ]; then \ echo "^ cyclomatic complexity exceeds 20, refactor the code!" && echo && exit 1; \ fi \ done fmt: @for d in `govendor list -no-status +local | sed 's/github.com.spf13.hugo/./'` ; do \ if [ "`gofmt -l $$d/*.go | tee /dev/stderr`" ]; then \ echo "^ improperly formatted go files" && echo && exit 1; \ fi \ done lint: @for d in `govendor list -no-status +local | sed 's/github.com.spf13.hugo/./'` ; do \ if [ "`golint $$d | tee /dev/stderr`" ]; then \ echo "^ golint errors!" && echo && exit 1; \ fi \ done get: go get -v -t ./... test: govendor test +local test-race: govendor test -race +local vet: @if [ "`govendor vet +local | tee /dev/stderr`" ]; then \ echo "^ go vet errors!" && echo && exit 1; \ fi test-cover-html: echo "mode: count" > coverage-all.out $(foreach pkg,$(PACKAGES),\ govendor test -coverprofile=coverage.out -covermode=count $(pkg);\ tail -n +2 coverage.out >> coverage-all.out;) go tool cover -html=coverage-all.outhugo-0.18.1/README.md000066400000000000000000000132621303124201100140110ustar00rootroot00000000000000![Hugo](https://raw.githubusercontent.com/spf13/hugo/master/docs/static/img/hugo-logo.png) A Fast and Flexible Static Site Generator built with love by [spf13](http://spf13.com/) and [friends](https://github.com/spf13/hugo/graphs/contributors) in [Go][]. [Website](https://gohugo.io) | [Forum](https://discuss.gohugo.io) | [Developer Chat (no support)](https://gitter.im/spf13/hugo) | [Documentation](https://gohugo.io/overview/introduction/) | [Installation Guide](https://gohugo.io/overview/installing/) | [Contribution Guide](CONTRIBUTING.md) | [Twitter](http://twitter.com/spf13) [![GoDoc](https://godoc.org/github.com/spf13/hugo?status.svg)](https://godoc.org/github.com/spf13/hugo) [![Linux and OS X Build Status](https://api.travis-ci.org/spf13/hugo.svg?branch=master&label=Linux+and+OS+X+build "Linux and OS X Build Status")](https://travis-ci.org/spf13/hugo) [![Windows Build Status](https://ci.appveyor.com/api/projects/status/n2mo912b8s2505e8/branch/master?svg=true&label=Windows+build "Windows Build Status")](https://ci.appveyor.com/project/spf13/hugo/branch/master) [![Dev chat at https://gitter.im/spf13/hugo](https://img.shields.io/badge/gitter-developer_chat-46bc99.svg)](https://gitter.im/spf13/hugo?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Go Report Card](https://goreportcard.com/badge/github.com/spf13/hugo)](https://goreportcard.com/report/github.com/spf13/hugo) ## Overview Hugo is a static HTML and CSS website 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 relies on Markdown files with front matter for meta data. 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 and OS X (Darwin) 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][].** ## Choose How to Install 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](https://github.com/spf13/hugo#fork-destination-box) 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. ### Install Hugo as Your Site Generator (Binary Install) Use the [installation instructions in the Hugo documentation](https://gohugo.io/overview/installing/). ### Build and Install the Binaries from Source (Advanced Install) Add Hugo and its package dependencies to your go `src` directory. go get -v github.com/spf13/hugo Once the `get` completes, you should find your new `hugo` (or `hugo.exe`) executable sitting inside `$GOPATH/bin/`. To update Hugo’s dependencies, use `go get` with the `-u` option. go get -u -v github.com/spf13/hugo ## Contributing to Hugo For a complete guide to contributing to Hugo, see the [Contribution Guide](CONTRIBUTING.md). 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. [![Throughput Graph](https://graphs.waffle.io/spf13/hugo/throughput.svg)](https://waffle.io/spf13/hugo/metrics) ### Asking Support Questions We have an active [discussion forum](http://discuss.gohugo.io) where users and developers can ask questions. Please don't use the Github issue tracker to ask questions. ### Reporting Issues 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](http://discuss.gohugo.io). When reporting the issue, please provide the version of Hugo in use (`hugo version`). ### Submitting Patches 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](CONTRIBUTING.md). [![Analytics](https://ga-beacon.appspot.com/UA-7131036-6/hugo/readme)](https://github.com/igrigorik/ga-beacon) [Go]: https://golang.org/ [Hugo Documentation]: https://gohugo.io/overview/introduction/ hugo-0.18.1/bench.sh000077500000000000000000000013561303124201100141510ustar00rootroot00000000000000#!/usr/bin/env bash # Convenience script to # - For a given branch # - Run benchmark tests for a given package # - Do the same for master # - then compare the two runs with benchcmp benchFilter=".*" if (( $# < 2 )); then echo "USAGE: ./bench.sh (and (regexp, optional))" exit 1 fi if [ $# -eq 3 ]; then benchFilter=$3 fi BRANCH=$1 PACKAGE=$2 git checkout $BRANCH go test -test.run=NONE -bench="$benchFilter" -test.benchmem=true ./$PACKAGE > /tmp/bench-$PACKAGE-$BRANCH.txt git checkout master go test -test.run=NONE -bench="$benchFilter" -test.benchmem=true ./$PACKAGE > /tmp/bench-$PACKAGE-master.txt benchcmp /tmp/bench-$PACKAGE-master.txt /tmp/bench-$PACKAGE-$BRANCH.txthugo-0.18.1/bufferpool/000077500000000000000000000000001303124201100146715ustar00rootroot00000000000000hugo-0.18.1/bufferpool/bufpool.go000066400000000000000000000021241303124201100166650ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Package bufferpool provides a pool of bytes buffers. package bufferpool import ( "bytes" "sync" ) var bufferPool = &sync.Pool{ New: func() interface{} { return &bytes.Buffer{} }, } // GetBuffer returns a buffer from the pool. func GetBuffer() (buf *bytes.Buffer) { return bufferPool.Get().(*bytes.Buffer) } // PutBuffer returns a buffer to the pool. // The buffer is reset before it is put back into circulation. func PutBuffer(buf *bytes.Buffer) { buf.Reset() bufferPool.Put(buf) } hugo-0.18.1/bufferpool/bufpool_test.go000066400000000000000000000015741303124201100177340ustar00rootroot00000000000000// Copyright 2016-present The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package bufferpool import ( "github.com/stretchr/testify/assert" "testing" ) func TestBufferPool(t *testing.T) { buff := GetBuffer() buff.WriteString("do be do be do") assert.Equal(t, "do be do be do", buff.String()) PutBuffer(buff) assert.Equal(t, 0, buff.Len()) } hugo-0.18.1/commands/000077500000000000000000000000001303124201100143275ustar00rootroot00000000000000hugo-0.18.1/commands/benchmark.go000066400000000000000000000055321303124201100166150ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "os" "runtime" "runtime/pprof" "time" "github.com/spf13/cobra" jww "github.com/spf13/jwalterweatherman" ) var ( benchmarkTimes int cpuProfileFile string memProfileFile string ) var benchmarkCmd = &cobra.Command{ Use: "benchmark", Short: "Benchmark Hugo by building a site a number of times.", Long: `Hugo can build a site many times over and analyze the running process creating a benchmark.`, } func init() { initHugoBuilderFlags(benchmarkCmd) initBenchmarkBuildingFlags(benchmarkCmd) benchmarkCmd.Flags().StringVar(&cpuProfileFile, "cpuprofile", "", "path/filename for the CPU profile file") benchmarkCmd.Flags().StringVar(&memProfileFile, "memprofile", "", "path/filename for the memory profile file") benchmarkCmd.Flags().IntVarP(&benchmarkTimes, "count", "n", 13, "number of times to build the site") benchmarkCmd.RunE = benchmark } func benchmark(cmd *cobra.Command, args []string) error { var err error if err = InitializeConfig(benchmarkCmd); err != nil { return err } var memProf *os.File if memProfileFile != "" { memProf, err = os.Create(memProfileFile) if err != nil { return err } } var cpuProf *os.File if cpuProfileFile != "" { cpuProf, err = os.Create(cpuProfileFile) if err != nil { return err } } var memStats runtime.MemStats runtime.ReadMemStats(&memStats) memAllocated := memStats.TotalAlloc mallocs := memStats.Mallocs if cpuProf != nil { pprof.StartCPUProfile(cpuProf) } t := time.Now() for i := 0; i < benchmarkTimes; i++ { if err = resetAndbuildSites(false); err != nil { return err } } totalTime := time.Since(t) if memProf != nil { pprof.WriteHeapProfile(memProf) memProf.Close() } if cpuProf != nil { pprof.StopCPUProfile() cpuProf.Close() } runtime.ReadMemStats(&memStats) totalMemAllocated := memStats.TotalAlloc - memAllocated totalMallocs := memStats.Mallocs - mallocs jww.FEEDBACK.Println() jww.FEEDBACK.Printf("Average time per operation: %vms\n", int(1000*totalTime.Seconds()/float64(benchmarkTimes))) jww.FEEDBACK.Printf("Average memory allocated per operation: %vkB\n", totalMemAllocated/uint64(benchmarkTimes)/1024) jww.FEEDBACK.Printf("Average allocations per operation: %v\n", totalMallocs/uint64(benchmarkTimes)) return nil } hugo-0.18.1/commands/check.go000066400000000000000000000013701303124201100157340ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "github.com/spf13/cobra" ) var checkCmd = &cobra.Command{ Use: "check", Short: "Contains some verification checks", } hugo-0.18.1/commands/convert.go000066400000000000000000000115711303124201100163430ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "errors" "fmt" "path/filepath" "time" "github.com/spf13/cast" "github.com/spf13/cobra" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugolib" "github.com/spf13/hugo/parser" jww "github.com/spf13/jwalterweatherman" "github.com/spf13/viper" ) var outputDir string var unsafe bool var convertCmd = &cobra.Command{ Use: "convert", Short: "Convert your content to different formats", Long: `Convert your content (e.g. front matter) to different formats. See convert's subcommands toJSON, toTOML and toYAML for more information.`, RunE: nil, } var toJSONCmd = &cobra.Command{ Use: "toJSON", Short: "Convert front matter to JSON", Long: `toJSON converts all front matter in the content directory to use JSON for the front matter.`, RunE: func(cmd *cobra.Command, args []string) error { return convertContents(rune([]byte(parser.JSONLead)[0])) }, } var toTOMLCmd = &cobra.Command{ Use: "toTOML", Short: "Convert front matter to TOML", Long: `toTOML converts all front matter in the content directory to use TOML for the front matter.`, RunE: func(cmd *cobra.Command, args []string) error { return convertContents(rune([]byte(parser.TOMLLead)[0])) }, } var toYAMLCmd = &cobra.Command{ Use: "toYAML", Short: "Convert front matter to YAML", Long: `toYAML converts all front matter in the content directory to use YAML for the front matter.`, RunE: func(cmd *cobra.Command, args []string) error { return convertContents(rune([]byte(parser.YAMLLead)[0])) }, } func init() { convertCmd.AddCommand(toJSONCmd) convertCmd.AddCommand(toTOMLCmd) convertCmd.AddCommand(toYAMLCmd) convertCmd.PersistentFlags().StringVarP(&outputDir, "output", "o", "", "filesystem path to write files to") convertCmd.PersistentFlags().StringVarP(&source, "source", "s", "", "filesystem path to read files relative from") convertCmd.PersistentFlags().BoolVar(&unsafe, "unsafe", false, "enable less safe operations, please backup first") convertCmd.PersistentFlags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{}) } func convertContents(mark rune) (err error) { if err := InitializeConfig(); err != nil { return err } h, err := hugolib.NewHugoSitesFromConfiguration() if err != nil { return err } site := h.Sites[0] if err = site.Initialise(); err != nil { return err } if site.Source == nil { panic("site.Source not set") } if len(site.Source.Files()) < 1 { return errors.New("No source files found") } contentDir := helpers.AbsPathify(viper.GetString("contentDir")) jww.FEEDBACK.Println("processing", len(site.Source.Files()), "content files") for _, file := range site.Source.Files() { jww.INFO.Println("Attempting to convert", file.LogicalName()) page, err := hugolib.NewPage(file.LogicalName()) if err != nil { return err } psr, err := parser.ReadFrom(file.Contents) if err != nil { jww.ERROR.Println("Error processing file:", file.Path()) return err } metadata, err := psr.Metadata() if err != nil { jww.ERROR.Println("Error processing file:", file.Path()) return err } // better handling of dates in formats that don't have support for them if mark == parser.FormatToLeadRune("json") || mark == parser.FormatToLeadRune("yaml") || mark == parser.FormatToLeadRune("toml") { newmetadata := cast.ToStringMap(metadata) for k, v := range newmetadata { switch vv := v.(type) { case time.Time: newmetadata[k] = vv.Format(time.RFC3339) } } metadata = newmetadata } page.SetDir(filepath.Join(contentDir, file.Dir())) page.SetSourceContent(psr.Content()) if err = page.SetSourceMetaData(metadata, mark); err != nil { jww.ERROR.Printf("Failed to set source metadata for file %q: %s. For more info see For more info see https://github.com/spf13/hugo/issues/2458", page.FullFilePath(), err) continue } if outputDir != "" { if err = page.SaveSourceAs(filepath.Join(outputDir, page.FullFilePath())); err != nil { return fmt.Errorf("Failed to save file %q: %s", page.FullFilePath(), err) } } else { if unsafe { if err = page.SaveSource(); err != nil { return fmt.Errorf("Failed to save file %q: %s", page.FullFilePath(), err) } } else { jww.FEEDBACK.Println("Unsafe operation not allowed, use --unsafe or set a different output path") } } } return } hugo-0.18.1/commands/env.go000066400000000000000000000022071303124201100154470ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "runtime" "github.com/spf13/cobra" jww "github.com/spf13/jwalterweatherman" ) var envCmd = &cobra.Command{ Use: "env", Short: "Print Hugo version and environment info", Long: `Print Hugo version and environment info. This is useful in Hugo bug reports.`, RunE: func(cmd *cobra.Command, args []string) error { printHugoVersion() jww.FEEDBACK.Printf("GOOS=%q\n", runtime.GOOS) jww.FEEDBACK.Printf("GOARCH=%q\n", runtime.GOARCH) jww.FEEDBACK.Printf("GOVERSION=%q\n", runtime.Version()) return nil }, } hugo-0.18.1/commands/gen.go000066400000000000000000000013751303124201100154350ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "github.com/spf13/cobra" ) var genCmd = &cobra.Command{ Use: "gen", Short: "A collection of several useful generators.", } hugo-0.18.1/commands/genautocomplete.go000066400000000000000000000043401303124201100200520ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "github.com/spf13/cobra" jww "github.com/spf13/jwalterweatherman" ) var autocompleteTarget string // bash for now (zsh and others will come) var autocompleteType string var genautocompleteCmd = &cobra.Command{ Use: "autocomplete", Short: "Generate shell autocompletion script for Hugo", Long: `Generates a shell autocompletion script for Hugo. NOTE: The current version supports Bash only. This should work for *nix systems with Bash installed. By default, the file is written directly to /etc/bash_completion.d for convenience, and the command may need superuser rights, e.g.: $ sudo hugo gen autocomplete Add ` + "`--completionfile=/path/to/file`" + ` flag to set alternative file-path and name. Logout and in again to reload the completion scripts, or just source them in directly: $ . /etc/bash_completion`, RunE: func(cmd *cobra.Command, args []string) error { if autocompleteType != "bash" { return newUserError("Only Bash is supported for now") } err := cmd.Root().GenBashCompletionFile(autocompleteTarget) if err != nil { return err } jww.FEEDBACK.Println("Bash completion file for Hugo saved to", autocompleteTarget) return nil }, } func init() { genautocompleteCmd.PersistentFlags().StringVarP(&autocompleteTarget, "completionfile", "", "/etc/bash_completion.d/hugo.sh", "Autocompletion file") genautocompleteCmd.PersistentFlags().StringVarP(&autocompleteType, "type", "", "bash", "Autocompletion type (currently only bash supported)") // For bash-completion genautocompleteCmd.PersistentFlags().SetAnnotation("completionfile", cobra.BashCompFilenameExt, []string{}) } hugo-0.18.1/commands/gendoc.go000066400000000000000000000051241303124201100161170ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "fmt" "path" "path/filepath" "strings" "time" "github.com/spf13/cobra" "github.com/spf13/cobra/doc" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugofs" jww "github.com/spf13/jwalterweatherman" ) const gendocFrontmatterTemplate = `--- date: %s title: "%s" slug: %s url: %s --- ` var gendocdir string var gendocCmd = &cobra.Command{ Use: "doc", Short: "Generate Markdown documentation for the Hugo CLI.", Long: `Generate Markdown documentation for the Hugo CLI. This command is, mostly, used to create up-to-date documentation of Hugo's command-line interface for http://gohugo.io/. It creates one Markdown file per command with front matter suitable for rendering in Hugo.`, RunE: func(cmd *cobra.Command, args []string) error { if !strings.HasSuffix(gendocdir, helpers.FilePathSeparator) { gendocdir += helpers.FilePathSeparator } if found, _ := helpers.Exists(gendocdir, hugofs.Os()); !found { jww.FEEDBACK.Println("Directory", gendocdir, "does not exist, creating...") hugofs.Os().MkdirAll(gendocdir, 0777) } now := time.Now().Format(time.RFC3339) prepender := func(filename string) string { name := filepath.Base(filename) base := strings.TrimSuffix(name, path.Ext(name)) url := "/commands/" + strings.ToLower(base) + "/" return fmt.Sprintf(gendocFrontmatterTemplate, now, strings.Replace(base, "_", " ", -1), base, url) } linkHandler := func(name string) string { base := strings.TrimSuffix(name, path.Ext(name)) return "/commands/" + strings.ToLower(base) + "/" } jww.FEEDBACK.Println("Generating Hugo command-line documentation in", gendocdir, "...") doc.GenMarkdownTreeCustom(cmd.Root(), gendocdir, prepender, linkHandler) jww.FEEDBACK.Println("Done.") return nil }, } func init() { gendocCmd.PersistentFlags().StringVar(&gendocdir, "dir", "/tmp/hugodoc/", "the directory to write the doc.") // For bash-completion gendocCmd.PersistentFlags().SetAnnotation("dir", cobra.BashCompSubdirsInDir, []string{}) } hugo-0.18.1/commands/genman.go000066400000000000000000000040371303124201100161270ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "fmt" "strings" "github.com/spf13/cobra" "github.com/spf13/cobra/doc" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugofs" jww "github.com/spf13/jwalterweatherman" ) var genmandir string var genmanCmd = &cobra.Command{ Use: "man", Short: "Generate man pages for the Hugo CLI", Long: `This command automatically generates up-to-date man pages of Hugo's command-line interface. By default, it creates the man page files in the "man" directory under the current directory.`, RunE: func(cmd *cobra.Command, args []string) error { header := &doc.GenManHeader{ Section: "1", Manual: "Hugo Manual", Source: fmt.Sprintf("Hugo %s", helpers.HugoVersion()), } if !strings.HasSuffix(genmandir, helpers.FilePathSeparator) { genmandir += helpers.FilePathSeparator } if found, _ := helpers.Exists(genmandir, hugofs.Os()); !found { jww.FEEDBACK.Println("Directory", genmandir, "does not exist, creating...") hugofs.Os().MkdirAll(genmandir, 0777) } cmd.Root().DisableAutoGenTag = true jww.FEEDBACK.Println("Generating Hugo man pages in", genmandir, "...") doc.GenManTree(cmd.Root(), header, genmandir) jww.FEEDBACK.Println("Done.") return nil }, } func init() { genmanCmd.PersistentFlags().StringVar(&genmandir, "dir", "man/", "the directory to write the man pages.") // For bash-completion genmanCmd.PersistentFlags().SetAnnotation("dir", cobra.BashCompSubdirsInDir, []string{}) } hugo-0.18.1/commands/hugo.go000066400000000000000000000722031303124201100156240ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Package commands defines and implements command-line commands and flags // used by Hugo. Commands and flags are implemented using Cobra. package commands import ( "fmt" "net/http" "os" "path/filepath" "runtime" "strings" "sync" "time" "github.com/spf13/hugo/tpl" "github.com/spf13/hugo/hugofs" "github.com/spf13/hugo/parser" flag "github.com/spf13/pflag" "regexp" "github.com/fsnotify/fsnotify" "github.com/spf13/afero" "github.com/spf13/cobra" "github.com/spf13/fsync" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugolib" "github.com/spf13/hugo/livereload" "github.com/spf13/hugo/utils" "github.com/spf13/hugo/watcher" jww "github.com/spf13/jwalterweatherman" "github.com/spf13/nitro" "github.com/spf13/viper" ) // Hugo represents the Hugo sites to build. This variable is exported as it // is used by at least one external library (the Hugo caddy plugin). We should // provide a cleaner external API, but until then, this is it. var Hugo *hugolib.HugoSites // Reset resets Hugo ready for a new full build. This is mainly only useful // for benchmark testing etc. via the CLI commands. func Reset() error { Hugo = nil viper.Reset() return nil } // commandError is an error used to signal different error situations in command handling. type commandError struct { s string userError bool } func (c commandError) Error() string { return c.s } func (c commandError) isUserError() bool { return c.userError } func newUserError(a ...interface{}) commandError { return commandError{s: fmt.Sprintln(a...), userError: true} } func newSystemError(a ...interface{}) commandError { return commandError{s: fmt.Sprintln(a...), userError: false} } func newSystemErrorF(format string, a ...interface{}) commandError { return commandError{s: fmt.Sprintf(format, a...), userError: false} } // Catch some of the obvious user errors from Cobra. // We don't want to show the usage message for every error. // The below may be to generic. Time will show. var userErrorRegexp = regexp.MustCompile("argument|flag|shorthand") func isUserError(err error) bool { if cErr, ok := err.(commandError); ok && cErr.isUserError() { return true } return userErrorRegexp.MatchString(err.Error()) } // HugoCmd is Hugo's root command. // Every other command attached to HugoCmd is a child command to it. var HugoCmd = &cobra.Command{ Use: "hugo", Short: "hugo builds your site", Long: `hugo is the main command, used to build your Hugo site. Hugo is a Fast and Flexible Static Site Generator built with love by spf13 and friends in Go. Complete documentation is available at http://gohugo.io/.`, RunE: func(cmd *cobra.Command, args []string) error { if err := InitializeConfig(); err != nil { return err } if buildWatch { viper.Set("disableLiveReload", true) watchConfig() } return build() }, } var hugoCmdV *cobra.Command // Flags that are to be added to commands. var ( buildWatch bool logging bool renderToMemory bool // for benchmark testing verbose bool verboseLog bool quiet bool ) var ( baseURL string cacheDir string contentDir string layoutDir string cfgFile string destination string logFile string theme string source string ) // Execute adds all child commands to the root command HugoCmd and sets flags appropriately. func Execute() { HugoCmd.SetGlobalNormalizationFunc(helpers.NormalizeHugoFlags) HugoCmd.SilenceUsage = true AddCommands() if c, err := HugoCmd.ExecuteC(); err != nil { if isUserError(err) { c.Println("") c.Println(c.UsageString()) } os.Exit(-1) } } // AddCommands adds child commands to the root command HugoCmd. func AddCommands() { HugoCmd.AddCommand(serverCmd) HugoCmd.AddCommand(versionCmd) HugoCmd.AddCommand(envCmd) HugoCmd.AddCommand(configCmd) HugoCmd.AddCommand(checkCmd) HugoCmd.AddCommand(benchmarkCmd) HugoCmd.AddCommand(convertCmd) HugoCmd.AddCommand(newCmd) HugoCmd.AddCommand(listCmd) HugoCmd.AddCommand(undraftCmd) HugoCmd.AddCommand(importCmd) HugoCmd.AddCommand(genCmd) genCmd.AddCommand(genautocompleteCmd) genCmd.AddCommand(gendocCmd) genCmd.AddCommand(genmanCmd) } // initHugoBuilderFlags initializes all common flags, typically used by the // core build commands, namely hugo itself, server, check and benchmark. func initHugoBuilderFlags(cmd *cobra.Command) { initHugoBuildCommonFlags(cmd) } func initRootPersistentFlags() { HugoCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is path/config.yaml|json|toml)") HugoCmd.PersistentFlags().BoolVar(&quiet, "quiet", false, "build in quiet mode") // Set bash-completion validConfigFilenames := []string{"json", "js", "yaml", "yml", "toml", "tml"} HugoCmd.PersistentFlags().SetAnnotation("config", cobra.BashCompFilenameExt, validConfigFilenames) } // initHugoBuildCommonFlags initialize common flags related to the Hugo build. // Called by initHugoBuilderFlags. func initHugoBuildCommonFlags(cmd *cobra.Command) { cmd.Flags().Bool("cleanDestinationDir", false, "Remove files from destination not found in static directories") cmd.Flags().BoolP("buildDrafts", "D", false, "include content marked as draft") cmd.Flags().BoolP("buildFuture", "F", false, "include content with publishdate in the future") cmd.Flags().BoolP("buildExpired", "E", false, "include expired content") cmd.Flags().Bool("disable404", false, "Do not render 404 page") cmd.Flags().Bool("disableRSS", false, "Do not build RSS files") cmd.Flags().Bool("disableSitemap", false, "Do not build Sitemap file") cmd.Flags().StringVarP(&source, "source", "s", "", "filesystem path to read files relative from") cmd.Flags().StringVarP(&contentDir, "contentDir", "c", "", "filesystem path to content directory") cmd.Flags().StringVarP(&layoutDir, "layoutDir", "l", "", "filesystem path to layout directory") cmd.Flags().StringVarP(&cacheDir, "cacheDir", "", "", "filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/") cmd.Flags().BoolP("ignoreCache", "", false, "Ignores the cache directory") cmd.Flags().StringVarP(&destination, "destination", "d", "", "filesystem path to write files to") cmd.Flags().StringVarP(&theme, "theme", "t", "", "theme to use (located in /themes/THEMENAME/)") cmd.Flags().Bool("uglyURLs", false, "if true, use /filename.html instead of /filename/") cmd.Flags().Bool("canonifyURLs", false, "if true, all relative URLs will be canonicalized using baseURL") cmd.Flags().StringVarP(&baseURL, "baseURL", "b", "", "hostname (and path) to the root, e.g. http://spf13.com/") cmd.Flags().Bool("enableGitInfo", false, "Add Git revision, date and author info to the pages") cmd.Flags().BoolVar(&nitro.AnalysisOn, "stepAnalysis", false, "display memory and timing of different steps of the program") cmd.Flags().Bool("pluralizeListTitles", true, "Pluralize titles in lists using inflect") cmd.Flags().Bool("preserveTaxonomyNames", false, `Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu")`) cmd.Flags().BoolP("forceSyncStatic", "", false, "Copy all files when static is changed.") cmd.Flags().BoolP("noTimes", "", false, "Don't sync modification time of files") cmd.Flags().BoolP("noChmod", "", false, "Don't sync permission mode of files") cmd.Flags().BoolVarP(&tpl.Logi18nWarnings, "i18n-warnings", "", false, "Print missing translations") // Set bash-completion. // Each flag must first be defined before using the SetAnnotation() call. cmd.Flags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{}) cmd.Flags().SetAnnotation("cacheDir", cobra.BashCompSubdirsInDir, []string{}) cmd.Flags().SetAnnotation("destination", cobra.BashCompSubdirsInDir, []string{}) cmd.Flags().SetAnnotation("theme", cobra.BashCompSubdirsInDir, []string{"themes"}) } func initBenchmarkBuildingFlags(cmd *cobra.Command) { cmd.Flags().BoolVar(&renderToMemory, "renderToMemory", false, "render to memory (only useful for benchmark testing)") } // init initializes flags. func init() { HugoCmd.PersistentFlags().BoolVarP(&verbose, "verbose", "v", false, "verbose output") HugoCmd.PersistentFlags().BoolVar(&logging, "log", false, "Enable Logging") HugoCmd.PersistentFlags().StringVar(&logFile, "logFile", "", "Log File path (if set, logging enabled automatically)") HugoCmd.PersistentFlags().BoolVar(&verboseLog, "verboseLog", false, "verbose logging") initRootPersistentFlags() initHugoBuilderFlags(HugoCmd) initBenchmarkBuildingFlags(HugoCmd) HugoCmd.Flags().BoolVarP(&buildWatch, "watch", "w", false, "watch filesystem for changes and recreate as needed") hugoCmdV = HugoCmd // Set bash-completion HugoCmd.PersistentFlags().SetAnnotation("logFile", cobra.BashCompFilenameExt, []string{}) } // InitializeConfig initializes a config file with sensible default configuration flags. func InitializeConfig(subCmdVs ...*cobra.Command) error { if err := hugolib.LoadGlobalConfig(source, cfgFile); err != nil { return err } for _, cmdV := range append([]*cobra.Command{hugoCmdV}, subCmdVs...) { initializeFlags(cmdV) } if baseURL != "" { if !strings.HasSuffix(baseURL, "/") { baseURL = baseURL + "/" } viper.Set("baseURL", baseURL) } if !viper.GetBool("relativeURLs") && viper.GetString("baseURL") == "" { jww.ERROR.Println("No 'baseURL' set in configuration or as a flag. Features like page menus will not work without one.") } if theme != "" { viper.Set("theme", theme) } if destination != "" { viper.Set("publishDir", destination) } var dir string if source != "" { dir, _ = filepath.Abs(source) } else { dir, _ = os.Getwd() } viper.Set("workingDir", dir) if contentDir != "" { viper.Set("contentDir", contentDir) } if layoutDir != "" { viper.Set("layoutDir", layoutDir) } if cacheDir != "" { viper.Set("cacheDir", cacheDir) } cacheDir = viper.GetString("cacheDir") if cacheDir != "" { if helpers.FilePathSeparator != cacheDir[len(cacheDir)-1:] { cacheDir = cacheDir + helpers.FilePathSeparator } isDir, err := helpers.DirExists(cacheDir, hugofs.Source()) utils.CheckErr(err) if !isDir { mkdir(cacheDir) } viper.Set("cacheDir", cacheDir) } else { viper.Set("cacheDir", helpers.GetTempDir("hugo_cache", hugofs.Source())) } if verboseLog || logging || (viper.IsSet("logFile") && viper.GetString("logFile") != "") { if viper.IsSet("logFile") && viper.GetString("logFile") != "" { jww.SetLogFile(viper.GetString("logFile")) } else { jww.UseTempLogFile("hugo") } } else { jww.DiscardLogging() } if quiet { jww.SetStdoutThreshold(jww.LevelError) } else if viper.GetBool("verbose") { jww.SetStdoutThreshold(jww.LevelInfo) } if verboseLog { jww.SetLogThreshold(jww.LevelInfo) } jww.INFO.Println("Using config file:", viper.ConfigFileUsed()) // Init file systems. This may be changed at a later point. hugofs.InitDefaultFs() themeDir := helpers.GetThemeDir() if themeDir != "" { if _, err := hugofs.Source().Stat(themeDir); os.IsNotExist(err) { return newSystemError("Unable to find theme Directory:", themeDir) } } themeVersionMismatch, minVersion := isThemeVsHugoVersionMismatch() if themeVersionMismatch { jww.ERROR.Printf("Current theme does not support Hugo version %s. Minimum version required is %s\n", helpers.HugoReleaseVersion(), minVersion) } return nil } func initializeFlags(cmd *cobra.Command) { persFlagKeys := []string{"verbose", "logFile"} flagKeys := []string{ "cleanDestinationDir", "buildDrafts", "buildFuture", "buildExpired", "uglyURLs", "canonifyURLs", "disable404", "disableRSS", "disableSitemap", "enableRobotsTXT", "enableGitInfo", "pluralizeListTitles", "preserveTaxonomyNames", "ignoreCache", "forceSyncStatic", "noTimes", "noChmod", } for _, key := range persFlagKeys { setValueFromFlag(cmd.PersistentFlags(), key) } for _, key := range flagKeys { setValueFromFlag(cmd.Flags(), key) } } func setValueFromFlag(flags *flag.FlagSet, key string) { if flagChanged(flags, key) { f := flags.Lookup(key) viper.Set(key, f.Value.String()) } } func flagChanged(flags *flag.FlagSet, key string) bool { flag := flags.Lookup(key) if flag == nil { return false } return flag.Changed } func watchConfig() { viper.WatchConfig() viper.OnConfigChange(func(e fsnotify.Event) { jww.FEEDBACK.Println("Config file changed:", e.Name) // Force a full rebuild utils.CheckErr(reCreateAndbuildSites(true)) if !viper.GetBool("disableLiveReload") { // Will block forever trying to write to a channel that nobody is reading if livereload isn't initialized livereload.ForceRefresh() } }) } func build(watches ...bool) error { // Hugo writes the output to memory instead of the disk // This is only used for benchmark testing. Cause the content is only visible // in memory if renderToMemory { hugofs.SetDestination(new(afero.MemMapFs)) // Rendering to memoryFS, publish to Root regardless of publishDir. viper.Set("publishDir", "/") } if err := copyStatic(); err != nil { return fmt.Errorf("Error copying static files to %s: %s", helpers.AbsPathify(viper.GetString("publishDir")), err) } watch := false if len(watches) > 0 && watches[0] { watch = true } if err := buildSites(buildWatch || watch); err != nil { return fmt.Errorf("Error building site: %s", err) } if buildWatch { jww.FEEDBACK.Println("Watching for changes in", helpers.AbsPathify(viper.GetString("contentDir"))) jww.FEEDBACK.Println("Press Ctrl+C to stop") utils.CheckErr(NewWatcher(0)) } return nil } func getStaticSourceFs() afero.Fs { source := hugofs.Source() themeDir, err := helpers.GetThemeStaticDirPath() staticDir := helpers.GetStaticDirPath() + helpers.FilePathSeparator useTheme := true useStatic := true if err != nil { jww.WARN.Println(err) useTheme = false } else { if _, err := source.Stat(themeDir); os.IsNotExist(err) { jww.WARN.Println("Unable to find Theme Static Directory:", themeDir) useTheme = false } } if _, err := source.Stat(staticDir); os.IsNotExist(err) { jww.WARN.Println("Unable to find Static Directory:", staticDir) useStatic = false } if !useStatic && !useTheme { return nil } if !useStatic { jww.INFO.Println(themeDir, "is the only static directory available to sync from") return afero.NewReadOnlyFs(afero.NewBasePathFs(source, themeDir)) } if !useTheme { jww.INFO.Println(staticDir, "is the only static directory available to sync from") return afero.NewReadOnlyFs(afero.NewBasePathFs(source, staticDir)) } jww.INFO.Println("using a UnionFS for static directory comprised of:") jww.INFO.Println("Base:", themeDir) jww.INFO.Println("Overlay:", staticDir) base := afero.NewReadOnlyFs(afero.NewBasePathFs(hugofs.Source(), themeDir)) overlay := afero.NewReadOnlyFs(afero.NewBasePathFs(hugofs.Source(), staticDir)) return afero.NewCopyOnWriteFs(base, overlay) } func copyStatic() error { publishDir := helpers.AbsPathify(viper.GetString("publishDir")) + helpers.FilePathSeparator // If root, remove the second '/' if publishDir == "//" { publishDir = helpers.FilePathSeparator } // Includes both theme/static & /static staticSourceFs := getStaticSourceFs() if staticSourceFs == nil { jww.WARN.Println("No static directories found to sync") return nil } syncer := fsync.NewSyncer() syncer.NoTimes = viper.GetBool("noTimes") syncer.NoChmod = viper.GetBool("noChmod") syncer.SrcFs = staticSourceFs syncer.DestFs = hugofs.Destination() // Now that we are using a unionFs for the static directories // We can effectively clean the publishDir on initial sync syncer.Delete = viper.GetBool("cleanDestinationDir") if syncer.Delete { jww.INFO.Println("removing all files from destination that don't exist in static dirs") } jww.INFO.Println("syncing static files to", publishDir) // because we are using a baseFs (to get the union right). // set sync src to root return syncer.Sync(publishDir, helpers.FilePathSeparator) } // getDirList provides NewWatcher() with a list of directories to watch for changes. func getDirList() []string { var a []string dataDir := helpers.AbsPathify(viper.GetString("dataDir")) i18nDir := helpers.AbsPathify(viper.GetString("i18nDir")) layoutDir := helpers.AbsPathify(viper.GetString("layoutDir")) staticDir := helpers.AbsPathify(viper.GetString("staticDir")) var themesDir string if helpers.ThemeSet() { themesDir = helpers.AbsPathify(viper.GetString("themesDir") + "/" + viper.GetString("theme")) } walker := func(path string, fi os.FileInfo, err error) error { if err != nil { if path == dataDir && os.IsNotExist(err) { jww.WARN.Println("Skip dataDir:", err) return nil } if path == i18nDir && os.IsNotExist(err) { jww.WARN.Println("Skip i18nDir:", err) return nil } if path == layoutDir && os.IsNotExist(err) { jww.WARN.Println("Skip layoutDir:", err) return nil } if path == staticDir && os.IsNotExist(err) { jww.WARN.Println("Skip staticDir:", err) return nil } if os.IsNotExist(err) { // Ignore. return nil } jww.ERROR.Println("Walker: ", err) return nil } if fi.Mode()&os.ModeSymlink == os.ModeSymlink { link, err := filepath.EvalSymlinks(path) if err != nil { jww.ERROR.Printf("Cannot read symbolic link '%s', error was: %s", path, err) return nil } linkfi, err := hugofs.Source().Stat(link) if err != nil { jww.ERROR.Printf("Cannot stat '%s', error was: %s", link, err) return nil } if !linkfi.Mode().IsRegular() { jww.ERROR.Printf("Symbolic links for directories not supported, skipping '%s'", path) } return nil } if fi.IsDir() { if fi.Name() == ".git" || fi.Name() == "node_modules" || fi.Name() == "bower_components" { return filepath.SkipDir } a = append(a, path) } return nil } helpers.SymbolicWalk(hugofs.Source(), dataDir, walker) helpers.SymbolicWalk(hugofs.Source(), helpers.AbsPathify(viper.GetString("contentDir")), walker) helpers.SymbolicWalk(hugofs.Source(), i18nDir, walker) helpers.SymbolicWalk(hugofs.Source(), helpers.AbsPathify(viper.GetString("layoutDir")), walker) helpers.SymbolicWalk(hugofs.Source(), staticDir, walker) if helpers.ThemeSet() { helpers.SymbolicWalk(hugofs.Source(), filepath.Join(themesDir, "layouts"), walker) helpers.SymbolicWalk(hugofs.Source(), filepath.Join(themesDir, "static"), walker) helpers.SymbolicWalk(hugofs.Source(), filepath.Join(themesDir, "i18n"), walker) helpers.SymbolicWalk(hugofs.Source(), filepath.Join(themesDir, "data"), walker) } return a } func reCreateAndbuildSites(watching bool) (err error) { if err := initSites(); err != nil { return err } if !quiet { jww.FEEDBACK.Println("Started building sites ...") } return Hugo.Build(hugolib.BuildCfg{CreateSitesFromConfig: true, Watching: watching, PrintStats: !quiet}) } func resetAndbuildSites(watching bool) (err error) { if err := initSites(); err != nil { return err } if !quiet { jww.FEEDBACK.Println("Started building sites ...") } return Hugo.Build(hugolib.BuildCfg{ResetState: true, Watching: watching, PrintStats: !quiet}) } func initSites() error { if Hugo != nil { return nil } h, err := hugolib.NewHugoSitesFromConfiguration() if err != nil { return err } Hugo = h return nil } func buildSites(watching bool) (err error) { if err := initSites(); err != nil { return err } if !quiet { jww.FEEDBACK.Println("Started building sites ...") } return Hugo.Build(hugolib.BuildCfg{Watching: watching, PrintStats: !quiet}) } func rebuildSites(events []fsnotify.Event) error { if err := initSites(); err != nil { return err } return Hugo.Build(hugolib.BuildCfg{PrintStats: !quiet, Watching: true}, events...) } // NewWatcher creates a new watcher to watch filesystem events. func NewWatcher(port int) error { if runtime.GOOS == "darwin" { tweakLimit() } watcher, err := watcher.New(1 * time.Second) var wg sync.WaitGroup if err != nil { return err } defer watcher.Close() wg.Add(1) for _, d := range getDirList() { if d != "" { _ = watcher.Add(d) } } go func() { for { select { case evs := <-watcher.Events: jww.INFO.Println("Received System Events:", evs) staticEvents := []fsnotify.Event{} dynamicEvents := []fsnotify.Event{} for _, ev := range evs { ext := filepath.Ext(ev.Name) baseName := filepath.Base(ev.Name) istemp := strings.HasSuffix(ext, "~") || (ext == ".swp") || // vim (ext == ".swx") || // vim (ext == ".tmp") || // generic temp file (ext == ".DS_Store") || // OSX Thumbnail baseName == "4913" || // vim strings.HasPrefix(ext, ".goutputstream") || // gnome strings.HasSuffix(ext, "jb_old___") || // intelliJ strings.HasSuffix(ext, "jb_tmp___") || // intelliJ strings.HasSuffix(ext, "jb_bak___") || // intelliJ strings.HasPrefix(ext, ".sb-") || // byword strings.HasPrefix(baseName, ".#") || // emacs strings.HasPrefix(baseName, "#") // emacs if istemp { continue } // Sometimes during rm -rf operations a '"": REMOVE' is triggered. Just ignore these if ev.Name == "" { continue } // Write and rename operations are often followed by CHMOD. // There may be valid use cases for rebuilding the site on CHMOD, // but that will require more complex logic than this simple conditional. // On OS X this seems to be related to Spotlight, see: // https://github.com/go-fsnotify/fsnotify/issues/15 // A workaround is to put your site(s) on the Spotlight exception list, // but that may be a little mysterious for most end users. // So, for now, we skip reload on CHMOD. // We do have to check for WRITE though. On slower laptops a Chmod // could be aggregated with other important events, and we still want // to rebuild on those if ev.Op&(fsnotify.Chmod|fsnotify.Write|fsnotify.Create) == fsnotify.Chmod { continue } walkAdder := func(path string, f os.FileInfo, err error) error { if f.IsDir() { jww.FEEDBACK.Println("adding created directory to watchlist", path) watcher.Add(path) } return nil } // recursively add new directories to watch list // When mkdir -p is used, only the top directory triggers an event (at least on OSX) if ev.Op&fsnotify.Create == fsnotify.Create { if s, err := hugofs.Source().Stat(ev.Name); err == nil && s.Mode().IsDir() { helpers.SymbolicWalk(hugofs.Source(), ev.Name, walkAdder) } } isstatic := strings.HasPrefix(ev.Name, helpers.GetStaticDirPath()) || (len(helpers.GetThemesDirPath()) > 0 && strings.HasPrefix(ev.Name, helpers.GetThemesDirPath())) if isstatic { staticEvents = append(staticEvents, ev) } else { dynamicEvents = append(dynamicEvents, ev) } } if len(staticEvents) > 0 { publishDir := helpers.AbsPathify(viper.GetString("publishDir")) + helpers.FilePathSeparator // If root, remove the second '/' if publishDir == "//" { publishDir = helpers.FilePathSeparator } jww.FEEDBACK.Println("\nStatic file changes detected") const layout = "2006-01-02 15:04 -0700" jww.FEEDBACK.Println(time.Now().Format(layout)) if viper.GetBool("forceSyncStatic") { jww.FEEDBACK.Printf("Syncing all static files\n") err := copyStatic() if err != nil { utils.StopOnErr(err, fmt.Sprintf("Error copying static files to %s", publishDir)) } } else { staticSourceFs := getStaticSourceFs() if staticSourceFs == nil { jww.WARN.Println("No static directories found to sync") return } syncer := fsync.NewSyncer() syncer.NoTimes = viper.GetBool("noTimes") syncer.NoChmod = viper.GetBool("noChmod") syncer.SrcFs = staticSourceFs syncer.DestFs = hugofs.Destination() // prevent spamming the log on changes logger := helpers.NewDistinctFeedbackLogger() for _, ev := range staticEvents { // Due to our approach of layering both directories and the content's rendered output // into one we can't accurately remove a file not in one of the source directories. // If a file is in the local static dir and also in the theme static dir and we remove // it from one of those locations we expect it to still exist in the destination // // If Hugo generates a file (from the content dir) over a static file // the content generated file should take precedence. // // Because we are now watching and handling individual events it is possible that a static // event that occupies the same path as a content generated file will take precedence // until a regeneration of the content takes places. // // Hugo assumes that these cases are very rare and will permit this bad behavior // The alternative is to track every single file and which pipeline rendered it // and then to handle conflict resolution on every event. fromPath := ev.Name // If we are here we already know the event took place in a static dir relPath, err := helpers.MakeStaticPathRelative(fromPath) if err != nil { jww.ERROR.Println(err) continue } // Remove || rename is harder and will require an assumption. // Hugo takes the following approach: // If the static file exists in any of the static source directories after this event // Hugo will re-sync it. // If it does not exist in all of the static directories Hugo will remove it. // // This assumes that Hugo has not generated content on top of a static file and then removed // the source of that static file. In this case Hugo will incorrectly remove that file // from the published directory. if ev.Op&fsnotify.Rename == fsnotify.Rename || ev.Op&fsnotify.Remove == fsnotify.Remove { if _, err := staticSourceFs.Stat(relPath); os.IsNotExist(err) { // If file doesn't exist in any static dir, remove it toRemove := filepath.Join(publishDir, relPath) logger.Println("File no longer exists in static dir, removing", toRemove) hugofs.Destination().RemoveAll(toRemove) } else if err == nil { // If file still exists, sync it logger.Println("Syncing", relPath, "to", publishDir) if err := syncer.Sync(filepath.Join(publishDir, relPath), relPath); err != nil { jww.ERROR.Println(err) } } else { jww.ERROR.Println(err) } continue } // For all other event operations Hugo will sync static. logger.Println("Syncing", relPath, "to", publishDir) if err := syncer.Sync(filepath.Join(publishDir, relPath), relPath); err != nil { jww.ERROR.Println(err) } } } if !buildWatch && !viper.GetBool("disableLiveReload") { // Will block forever trying to write to a channel that nobody is reading if livereload isn't initialized // force refresh when more than one file if len(staticEvents) > 0 { for _, ev := range staticEvents { path, _ := helpers.MakeStaticPathRelative(ev.Name) livereload.RefreshPath(path) } } else { livereload.ForceRefresh() } } } if len(dynamicEvents) > 0 { jww.FEEDBACK.Println("\nChange detected, rebuilding site") const layout = "2006-01-02 15:04 -0700" jww.FEEDBACK.Println(time.Now().Format(layout)) rebuildSites(dynamicEvents) if !buildWatch && !viper.GetBool("disableLiveReload") { // Will block forever trying to write to a channel that nobody is reading if livereload isn't initialized livereload.ForceRefresh() } } case err := <-watcher.Errors: if err != nil { jww.ERROR.Println(err) } } } }() if port > 0 { if !viper.GetBool("disableLiveReload") { livereload.Initialize() http.HandleFunc("/livereload.js", livereload.ServeJS) http.HandleFunc("/livereload", livereload.Handler) } go serve(port) } wg.Wait() return nil } // isThemeVsHugoVersionMismatch returns whether the current Hugo version is // less than the theme's min_version. func isThemeVsHugoVersionMismatch() (mismatch bool, requiredMinVersion string) { if !helpers.ThemeSet() { return } themeDir := helpers.GetThemeDir() fs := hugofs.Source() path := filepath.Join(themeDir, "theme.toml") exists, err := helpers.Exists(path, fs) if err != nil || !exists { return } b, err := afero.ReadFile(fs, path) c, err := parser.HandleTOMLMetaData(b) if err != nil { return } config := c.(map[string]interface{}) if minVersion, ok := config["min_version"]; ok { switch minVersion.(type) { case float32: return helpers.HugoVersionNumber < minVersion.(float32), fmt.Sprint(minVersion) case float64: return helpers.HugoVersionNumber < minVersion.(float64), fmt.Sprint(minVersion) default: return } } return } hugo-0.18.1/commands/hugo_windows.go000066400000000000000000000016661303124201100174030ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import "github.com/spf13/cobra" func init() { // This message to show to Windows users if Hugo is opened from explorer.exe cobra.MousetrapHelpText = ` Hugo is a command-line tool for generating static website. You need to open cmd.exe and run Hugo from there. Visit http://gohugo.io/ for more information.` } hugo-0.18.1/commands/import_jekyll.go000066400000000000000000000313631303124201100175500ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "bytes" "errors" "io" "io/ioutil" "os" "path/filepath" "regexp" "strconv" "strings" "time" "github.com/spf13/cast" "github.com/spf13/cobra" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugofs" "github.com/spf13/hugo/hugolib" "github.com/spf13/hugo/parser" jww "github.com/spf13/jwalterweatherman" ) func init() { importCmd.AddCommand(importJekyllCmd) } var importCmd = &cobra.Command{ Use: "import", Short: "Import your site from others.", Long: `Import your site from other web site generators like Jekyll. Import requires a subcommand, e.g. ` + "`hugo import jekyll jekyll_root_path target_path`.", RunE: nil, } var importJekyllCmd = &cobra.Command{ Use: "jekyll", Short: "hugo import from Jekyll", Long: `hugo import from Jekyll. Import from Jekyll requires two paths, e.g. ` + "`hugo import jekyll jekyll_root_path target_path`.", RunE: importFromJekyll, } func init() { importJekyllCmd.Flags().Bool("force", false, "Allow import into non-empty target directory") } func importFromJekyll(cmd *cobra.Command, args []string) error { jww.SetLogThreshold(jww.LevelTrace) jww.SetStdoutThreshold(jww.LevelWarn) if len(args) < 2 { return newUserError(`Import from Jekyll requires two paths, e.g. ` + "`hugo import jekyll jekyll_root_path target_path`.") } jekyllRoot, err := filepath.Abs(filepath.Clean(args[0])) if err != nil { return newUserError("Path error:", args[0]) } targetDir, err := filepath.Abs(filepath.Clean(args[1])) if err != nil { return newUserError("Path error:", args[1]) } jww.INFO.Println("Import Jekyll from:", jekyllRoot, "to:", targetDir) if strings.HasPrefix(filepath.Dir(targetDir), jekyllRoot) { return newUserError("Target path should not be inside the Jekyll root, aborting.") } forceImport, _ := cmd.Flags().GetBool("force") if err := createSiteFromJekyll(jekyllRoot, targetDir, forceImport); err != nil { return newUserError(err) } jww.FEEDBACK.Println("Importing...") fileCount := 0 callback := func(path string, fi os.FileInfo, err error) error { if err != nil { return err } if fi.IsDir() { return nil } relPath, err := filepath.Rel(jekyllRoot, path) if err != nil { return newUserError("Get rel path error:", path) } relPath = filepath.ToSlash(relPath) draft := false switch { case strings.HasPrefix(relPath, "_posts/"): relPath = "content/post" + relPath[len("_posts"):] case strings.HasPrefix(relPath, "_drafts/"): relPath = "content/draft" + relPath[len("_drafts"):] draft = true default: return nil } fileCount++ return convertJekyllPost(path, relPath, targetDir, draft) } err = helpers.SymbolicWalk(hugofs.Os(), jekyllRoot, callback) if err != nil { return err } jww.FEEDBACK.Println("Congratulations!", fileCount, "post(s) imported!") jww.FEEDBACK.Println("Now, start Hugo by yourself:\n" + "$ git clone https://github.com/spf13/herring-cove.git " + args[1] + "/themes/herring-cove") jww.FEEDBACK.Println("$ cd " + args[1] + "\n$ hugo server --theme=herring-cove") return nil } // TODO: Consider calling doNewSite() instead? func createSiteFromJekyll(jekyllRoot, targetDir string, force bool) error { fs := hugofs.Source() if exists, _ := helpers.Exists(targetDir, fs); exists { if isDir, _ := helpers.IsDir(targetDir, fs); !isDir { return errors.New("Target path \"" + targetDir + "\" already exists but not a directory") } isEmpty, _ := helpers.IsEmpty(targetDir, fs) if !isEmpty && !force { return errors.New("Target path \"" + targetDir + "\" already exists and is not empty") } } jekyllConfig := loadJekyllConfig(jekyllRoot) // Crude test to make sure at least one of _drafts/ and _posts/ exists // and is not empty. hasPostsOrDrafts := false postsDir := filepath.Join(jekyllRoot, "_posts") draftsDir := filepath.Join(jekyllRoot, "_drafts") for _, d := range []string{postsDir, draftsDir} { if exists, _ := helpers.Exists(d, fs); exists { if isDir, _ := helpers.IsDir(d, fs); isDir { if isEmpty, _ := helpers.IsEmpty(d, fs); !isEmpty { hasPostsOrDrafts = true } } } } if !hasPostsOrDrafts { return errors.New("Your Jekyll root contains neither posts nor drafts, aborting.") } mkdir(targetDir, "layouts") mkdir(targetDir, "content") mkdir(targetDir, "archetypes") mkdir(targetDir, "static") mkdir(targetDir, "data") mkdir(targetDir, "themes") createConfigFromJekyll(targetDir, "yaml", jekyllConfig) copyJekyllFilesAndFolders(jekyllRoot, filepath.Join(targetDir, "static")) return nil } func loadJekyllConfig(jekyllRoot string) map[string]interface{} { fs := hugofs.Source() path := filepath.Join(jekyllRoot, "_config.yml") exists, err := helpers.Exists(path, fs) if err != nil || !exists { jww.WARN.Println("_config.yaml not found: Is the specified Jekyll root correct?") return nil } f, err := fs.Open(path) if err != nil { return nil } defer f.Close() b, err := ioutil.ReadAll(f) if err != nil { return nil } c, err := parser.HandleYAMLMetaData(b) if err != nil { return nil } return c.(map[string]interface{}) } func createConfigFromJekyll(inpath string, kind string, jekyllConfig map[string]interface{}) (err error) { title := "My New Hugo Site" baseURL := "http://example.org/" for key, value := range jekyllConfig { lowerKey := strings.ToLower(key) switch lowerKey { case "title": if str, ok := value.(string); ok { title = str } case "url": if str, ok := value.(string); ok { baseURL = str } } } in := map[string]interface{}{ "baseURL": baseURL, "title": title, "languageCode": "en-us", "disablePathToLower": true, } kind = parser.FormatSanitize(kind) by, err := parser.InterfaceToConfig(in, parser.FormatToLeadRune(kind)) if err != nil { return err } err = helpers.WriteToDisk(filepath.Join(inpath, "config."+kind), bytes.NewReader(by), hugofs.Source()) if err != nil { return } return nil } func copyFile(source string, dest string) error { sf, err := os.Open(source) if err != nil { return err } defer sf.Close() df, err := os.Create(dest) if err != nil { return err } defer df.Close() _, err = io.Copy(df, sf) if err == nil { si, err := os.Stat(source) if err != nil { err = os.Chmod(dest, si.Mode()) if err != nil { return err } } } return nil } func copyDir(source string, dest string) error { fi, err := os.Stat(source) if err != nil { return err } if !fi.IsDir() { return errors.New(source + " is not a directory") } err = os.MkdirAll(dest, fi.Mode()) if err != nil { return err } entries, err := ioutil.ReadDir(source) for _, entry := range entries { sfp := filepath.Join(source, entry.Name()) dfp := filepath.Join(dest, entry.Name()) if entry.IsDir() { err = copyDir(sfp, dfp) if err != nil { jww.ERROR.Println(err) } } else { err = copyFile(sfp, dfp) if err != nil { jww.ERROR.Println(err) } } } return nil } func copyJekyllFilesAndFolders(jekyllRoot string, dest string) error { fi, err := os.Stat(jekyllRoot) if err != nil { return err } if !fi.IsDir() { return errors.New(jekyllRoot + " is not a directory") } err = os.MkdirAll(dest, fi.Mode()) if err != nil { return err } entries, err := ioutil.ReadDir(jekyllRoot) for _, entry := range entries { sfp := filepath.Join(jekyllRoot, entry.Name()) dfp := filepath.Join(dest, entry.Name()) if entry.IsDir() { if entry.Name()[0] != '_' && entry.Name()[0] != '.' { err = copyDir(sfp, dfp) if err != nil { jww.ERROR.Println(err) } } } else { lowerEntryName := strings.ToLower(entry.Name()) exceptSuffix := []string{".md", ".markdown", ".html", ".htm", ".xml", ".textile", "rakefile", "gemfile", ".lock"} isExcept := false for _, suffix := range exceptSuffix { if strings.HasSuffix(lowerEntryName, suffix) { isExcept = true break } } if !isExcept && entry.Name()[0] != '.' && entry.Name()[0] != '_' { err = copyFile(sfp, dfp) if err != nil { jww.ERROR.Println(err) } } } } return nil } func parseJekyllFilename(filename string) (time.Time, string, error) { re := regexp.MustCompile(`(\d+-\d+-\d+)-(.+)\..*`) r := re.FindAllStringSubmatch(filename, -1) if len(r) == 0 { return time.Now(), "", errors.New("filename not match") } postDate, err := time.Parse("2006-01-02", r[0][1]) if err != nil { return time.Now(), "", err } postName := r[0][2] return postDate, postName, nil } func convertJekyllPost(path, relPath, targetDir string, draft bool) error { jww.TRACE.Println("Converting", path) filename := filepath.Base(path) postDate, postName, err := parseJekyllFilename(filename) if err != nil { jww.WARN.Printf("Failed to parse filename '%s': %s. Skipping.", filename, err) return nil } jww.TRACE.Println(filename, postDate, postName) targetFile := filepath.Join(targetDir, relPath) targetParentDir := filepath.Dir(targetFile) os.MkdirAll(targetParentDir, 0777) contentBytes, err := ioutil.ReadFile(path) if err != nil { jww.ERROR.Println("Read file error:", path) return err } psr, err := parser.ReadFrom(bytes.NewReader(contentBytes)) if err != nil { jww.ERROR.Println("Parse file error:", path) return err } metadata, err := psr.Metadata() if err != nil { jww.ERROR.Println("Processing file error:", path) return err } newmetadata, err := convertJekyllMetaData(metadata, postName, postDate, draft) if err != nil { jww.ERROR.Println("Convert metadata error:", path) return err } jww.TRACE.Println(newmetadata) content := convertJekyllContent(newmetadata, string(psr.Content())) page, err := hugolib.NewPage(filename) if err != nil { jww.ERROR.Println("New page error", filename) return err } page.SetDir(targetParentDir) page.SetSourceContent([]byte(content)) page.SetSourceMetaData(newmetadata, parser.FormatToLeadRune("yaml")) page.SaveSourceAs(targetFile) jww.TRACE.Println("Target file:", targetFile) return nil } func convertJekyllMetaData(m interface{}, postName string, postDate time.Time, draft bool) (interface{}, error) { url := postDate.Format("/2006/01/02/") + postName + "/" metadata, err := cast.ToStringMapE(m) if err != nil { return nil, err } if draft { metadata["draft"] = true } for key, value := range metadata { lowerKey := strings.ToLower(key) switch lowerKey { case "layout": delete(metadata, key) case "permalink": if str, ok := value.(string); ok { url = str } delete(metadata, key) case "category": if str, ok := value.(string); ok { metadata["categories"] = []string{str} } delete(metadata, key) case "excerpt_separator": if key != lowerKey { delete(metadata, key) metadata[lowerKey] = value } case "date": if str, ok := value.(string); ok { re := regexp.MustCompile(`(\d+):(\d+):(\d+)`) r := re.FindAllStringSubmatch(str, -1) if len(r) > 0 { hour, _ := strconv.Atoi(r[0][1]) minute, _ := strconv.Atoi(r[0][2]) second, _ := strconv.Atoi(r[0][3]) postDate = time.Date(postDate.Year(), postDate.Month(), postDate.Day(), hour, minute, second, 0, time.UTC) } } delete(metadata, key) } } metadata["url"] = url metadata["date"] = postDate.Format(time.RFC3339) return metadata, nil } func convertJekyllContent(m interface{}, content string) string { metadata, _ := cast.ToStringMapE(m) lines := strings.Split(content, "\n") var resultLines []string for _, line := range lines { resultLines = append(resultLines, strings.Trim(line, "\r\n")) } content = strings.Join(resultLines, "\n") excerptSep := "" if value, ok := metadata["excerpt_separator"]; ok { if str, strOk := value.(string); strOk { content = strings.Replace(content, strings.TrimSpace(str), excerptSep, -1) } } replaceList := []struct { re *regexp.Regexp replace string }{ {regexp.MustCompile(""), ""}, {regexp.MustCompile(`\{%\s*raw\s*%\}\s*(.*?)\s*\{%\s*endraw\s*%\}`), "$1"}, {regexp.MustCompile(`{%\s*highlight\s*(.*?)\s*%}`), "{{< highlight $1 >}}"}, {regexp.MustCompile(`{%\s*endhighlight\s*%}`), "{{< / highlight >}}"}, } for _, replace := range replaceList { content = replace.re.ReplaceAllString(content, replace.replace) } return content } hugo-0.18.1/commands/import_jekyll_test.go000066400000000000000000000100701303124201100205770ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "encoding/json" "github.com/stretchr/testify/assert" "testing" "time" ) func TestParseJekyllFilename(t *testing.T) { filenameArray := []string{ "2015-01-02-test.md", "2012-03-15-中文.markup", } expectResult := []struct { postDate time.Time postName string }{ {time.Date(2015, time.January, 2, 0, 0, 0, 0, time.UTC), "test"}, {time.Date(2012, time.March, 15, 0, 0, 0, 0, time.UTC), "中文"}, } for i, filename := range filenameArray { postDate, postName, err := parseJekyllFilename(filename) assert.Equal(t, err, nil) assert.Equal(t, expectResult[i].postDate.Format("2006-01-02"), postDate.Format("2006-01-02")) assert.Equal(t, expectResult[i].postName, postName) } } func TestConvertJekyllMetadata(t *testing.T) { testDataList := []struct { metadata interface{} postName string postDate time.Time draft bool expect string }{ {map[interface{}]interface{}{}, "testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false, `{"date":"2015-10-01T00:00:00Z","url":"/2015/10/01/testPost/"}`}, {map[interface{}]interface{}{}, "testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), true, `{"date":"2015-10-01T00:00:00Z","draft":true,"url":"/2015/10/01/testPost/"}`}, {map[interface{}]interface{}{"Permalink": "/permalink.html", "layout": "post"}, "testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false, `{"date":"2015-10-01T00:00:00Z","url":"/permalink.html"}`}, {map[interface{}]interface{}{"permalink": "/permalink.html"}, "testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false, `{"date":"2015-10-01T00:00:00Z","url":"/permalink.html"}`}, {map[interface{}]interface{}{"category": nil, "permalink": 123}, "testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false, `{"date":"2015-10-01T00:00:00Z","url":"/2015/10/01/testPost/"}`}, {map[interface{}]interface{}{"Excerpt_Separator": "sep"}, "testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false, `{"date":"2015-10-01T00:00:00Z","excerpt_separator":"sep","url":"/2015/10/01/testPost/"}`}, {map[interface{}]interface{}{"category": "book", "layout": "post", "Others": "Goods", "Date": "2015-10-01 12:13:11"}, "testPost", time.Date(2015, 10, 1, 0, 0, 0, 0, time.UTC), false, `{"Others":"Goods","categories":["book"],"date":"2015-10-01T12:13:11Z","url":"/2015/10/01/testPost/"}`}, } for _, data := range testDataList { result, err := convertJekyllMetaData(data.metadata, data.postName, data.postDate, data.draft) assert.Equal(t, nil, err) jsonResult, err := json.Marshal(result) assert.Equal(t, nil, err) assert.Equal(t, data.expect, string(jsonResult)) } } func TestConvertJekyllContent(t *testing.T) { testDataList := []struct { metadata interface{} content string expect string }{ {map[interface{}]interface{}{}, `Test content\n\npart2 content`, `Test content\n\npart2 content`}, {map[interface{}]interface{}{"excerpt_separator": ""}, `Test content\n\npart2 content`, `Test content\n\npart2 content`}, {map[interface{}]interface{}{}, "{% raw %}text{% endraw %}", "text"}, {map[interface{}]interface{}{}, "{%raw%} text2 {%endraw %}", "text2"}, {map[interface{}]interface{}{}, "{% highlight go %}\nvar s int\n{% endhighlight %}", "{{< highlight go >}}\nvar s int\n{{< / highlight >}}"}, } for _, data := range testDataList { result := convertJekyllContent(data.metadata, data.content) assert.Equal(t, data.expect, result) } } hugo-0.18.1/commands/limit_darwin.go000066400000000000000000000052731303124201100173470ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // +build darwin // Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "syscall" "github.com/spf13/cobra" jww "github.com/spf13/jwalterweatherman" ) func init() { checkCmd.AddCommand(limit) } var limit = &cobra.Command{ Use: "ulimit", Short: "Check system ulimit settings", Long: `Hugo will inspect the current ulimit settings on the system. This is primarily to ensure that Hugo can watch enough files on some OSs`, RunE: func(cmd *cobra.Command, args []string) error { var rLimit syscall.Rlimit err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) if err != nil { return newSystemError("Error Getting Rlimit ", err) } jww.FEEDBACK.Println("Current rLimit:", rLimit) jww.FEEDBACK.Println("Attempting to increase limit") rLimit.Max = 999999 rLimit.Cur = 999999 err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit) if err != nil { return newSystemError("Error Setting rLimit ", err) } err = syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) if err != nil { return newSystemError("Error Getting rLimit ", err) } jww.FEEDBACK.Println("rLimit after change:", rLimit) return nil }, } func tweakLimit() { var rLimit syscall.Rlimit err := syscall.Getrlimit(syscall.RLIMIT_NOFILE, &rLimit) if err != nil { jww.ERROR.Println("Unable to obtain rLimit", err) } if rLimit.Cur < rLimit.Max { rLimit.Max = 999999 rLimit.Cur = 999999 err = syscall.Setrlimit(syscall.RLIMIT_NOFILE, &rLimit) if err != nil { jww.ERROR.Println("Unable to increase number of open files limit", err) } } } hugo-0.18.1/commands/limit_others.go000066400000000000000000000024161303124201100173630ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // +build !darwin // Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands func tweakLimit() { // nothing to do } hugo-0.18.1/commands/list.go000066400000000000000000000070651303124201100156410ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "path/filepath" "github.com/spf13/cobra" "github.com/spf13/hugo/hugolib" jww "github.com/spf13/jwalterweatherman" "github.com/spf13/viper" ) func init() { listCmd.AddCommand(listDraftsCmd) listCmd.AddCommand(listFutureCmd) listCmd.AddCommand(listExpiredCmd) listCmd.PersistentFlags().StringVarP(&source, "source", "s", "", "filesystem path to read files relative from") listCmd.PersistentFlags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{}) } var listCmd = &cobra.Command{ Use: "list", Short: "Listing out various types of content", Long: `Listing out various types of content. List requires a subcommand, e.g. ` + "`hugo list drafts`.", RunE: nil, } var listDraftsCmd = &cobra.Command{ Use: "drafts", Short: "List all drafts", Long: `List all of the drafts in your content directory.`, RunE: func(cmd *cobra.Command, args []string) error { if err := InitializeConfig(); err != nil { return err } viper.Set("buildDrafts", true) sites, err := hugolib.NewHugoSitesFromConfiguration() if err != nil { return newSystemError("Error creating sites", err) } if err := sites.Build(hugolib.BuildCfg{SkipRender: true}); err != nil { return newSystemError("Error Processing Source Content", err) } for _, p := range sites.Pages() { if p.IsDraft() { jww.FEEDBACK.Println(filepath.Join(p.File.Dir(), p.File.LogicalName())) } } return nil }, } var listFutureCmd = &cobra.Command{ Use: "future", Short: "List all posts dated in the future", Long: `List all of the posts in your content directory which will be posted in the future.`, RunE: func(cmd *cobra.Command, args []string) error { if err := InitializeConfig(); err != nil { return err } viper.Set("buildFuture", true) sites, err := hugolib.NewHugoSitesFromConfiguration() if err != nil { return newSystemError("Error creating sites", err) } if err := sites.Build(hugolib.BuildCfg{SkipRender: true}); err != nil { return newSystemError("Error Processing Source Content", err) } for _, p := range sites.Pages() { if p.IsFuture() { jww.FEEDBACK.Println(filepath.Join(p.File.Dir(), p.File.LogicalName())) } } return nil }, } var listExpiredCmd = &cobra.Command{ Use: "expired", Short: "List all posts already expired", Long: `List all of the posts in your content directory which has already expired.`, RunE: func(cmd *cobra.Command, args []string) error { if err := InitializeConfig(); err != nil { return err } viper.Set("buildExpired", true) sites, err := hugolib.NewHugoSitesFromConfiguration() if err != nil { return newSystemError("Error creating sites", err) } if err := sites.Build(hugolib.BuildCfg{SkipRender: true}); err != nil { return newSystemError("Error Processing Source Content", err) } for _, p := range sites.Pages() { if p.IsExpired() { jww.FEEDBACK.Println(filepath.Join(p.File.Dir(), p.File.LogicalName())) } } return nil }, } hugo-0.18.1/commands/list_config.go000066400000000000000000000031541303124201100171610ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License.Print the version number of Hug package commands import ( "reflect" "sort" "github.com/spf13/cobra" jww "github.com/spf13/jwalterweatherman" "github.com/spf13/viper" ) var configCmd = &cobra.Command{ Use: "config", Short: "Print the site configuration", Long: `Print the site configuration, both default and custom settings.`, } func init() { configCmd.RunE = config } func config(cmd *cobra.Command, args []string) error { if err := InitializeConfig(configCmd); err != nil { return err } allSettings := viper.AllSettings() var separator string if allSettings["metadataformat"] == "toml" { separator = " = " } else { separator = ": " } var keys []string for k := range allSettings { keys = append(keys, k) } sort.Strings(keys) for _, k := range keys { kv := reflect.ValueOf(allSettings[k]) if kv.Kind() == reflect.String { jww.FEEDBACK.Printf("%s%s\"%+v\"\n", k, separator, allSettings[k]) } else { jww.FEEDBACK.Printf("%s%s%+v\n", k, separator, allSettings[k]) } } return nil } hugo-0.18.1/commands/new.go000066400000000000000000000240041303124201100154470ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "bytes" "errors" "os" "path/filepath" "strings" "time" "github.com/spf13/cobra" "github.com/spf13/hugo/create" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugofs" "github.com/spf13/hugo/parser" jww "github.com/spf13/jwalterweatherman" "github.com/spf13/viper" ) var ( configFormat string contentEditor string contentType string ) func init() { newSiteCmd.Flags().StringVarP(&configFormat, "format", "f", "toml", "config & frontmatter format") newSiteCmd.Flags().Bool("force", false, "Init inside non-empty directory") newCmd.Flags().StringVarP(&configFormat, "format", "f", "toml", "frontmatter format") newCmd.Flags().StringVarP(&contentType, "kind", "k", "", "Content type to create") newCmd.PersistentFlags().StringVarP(&source, "source", "s", "", "filesystem path to read files relative from") newCmd.PersistentFlags().SetAnnotation("source", cobra.BashCompSubdirsInDir, []string{}) newCmd.Flags().StringVar(&contentEditor, "editor", "", "edit new content with this editor, if provided") newCmd.AddCommand(newSiteCmd) newCmd.AddCommand(newThemeCmd) } var newCmd = &cobra.Command{ Use: "new [path]", Short: "Create new content for your site", Long: `Create a new content file and automatically set the date and title. It will guess which kind of file to create based on the path provided. You can also specify the kind with ` + "`-k KIND`" + `. If archetypes are provided in your theme or site, they will be used.`, RunE: NewContent, } var newSiteCmd = &cobra.Command{ Use: "site [path]", Short: "Create a new site (skeleton)", Long: `Create a new site in the provided directory. The new site will have the correct structure, but no content or theme yet. Use ` + "`hugo new [contentPath]`" + ` to create new content.`, RunE: NewSite, } var newThemeCmd = &cobra.Command{ Use: "theme [name]", Short: "Create a new theme", Long: `Create a new theme (skeleton) called [name] in the current directory. New theme is a skeleton. Please add content to the touched files. Add your name to the copyright line in the license and adjust the theme.toml file as you see fit.`, RunE: NewTheme, } // NewContent adds new content to a Hugo site. func NewContent(cmd *cobra.Command, args []string) error { if err := InitializeConfig(); err != nil { return err } if flagChanged(cmd.Flags(), "format") { viper.Set("metaDataFormat", configFormat) } if flagChanged(cmd.Flags(), "editor") { viper.Set("newContentEditor", contentEditor) } if len(args) < 1 { return newUserError("path needs to be provided") } createpath := args[0] var kind string createpath, kind = newContentPathSection(createpath) if contentType != "" { kind = contentType } return create.NewContent(hugofs.Source(), kind, createpath) } func doNewSite(basepath string, force bool) error { dirs := []string{ filepath.Join(basepath, "layouts"), filepath.Join(basepath, "content"), filepath.Join(basepath, "archetypes"), filepath.Join(basepath, "static"), filepath.Join(basepath, "data"), filepath.Join(basepath, "themes"), } if exists, _ := helpers.Exists(basepath, hugofs.Source()); exists { if isDir, _ := helpers.IsDir(basepath, hugofs.Source()); !isDir { return errors.New(basepath + " already exists but not a directory") } isEmpty, _ := helpers.IsEmpty(basepath, hugofs.Source()) switch { case !isEmpty && !force: return errors.New(basepath + " already exists and is not empty") case !isEmpty && force: all := append(dirs, filepath.Join(basepath, "config."+configFormat)) for _, path := range all { if exists, _ := helpers.Exists(path, hugofs.Source()); exists { return errors.New(path + " already exists") } } } } for _, dir := range dirs { hugofs.Source().MkdirAll(dir, 0777) } createConfig(basepath, configFormat) jww.FEEDBACK.Printf("Congratulations! Your new Hugo site is created in %s.\n\n", basepath) jww.FEEDBACK.Println(nextStepsText()) return nil } func nextStepsText() string { var nextStepsText bytes.Buffer nextStepsText.WriteString(`Just a few more steps and you're ready to go: 1. Download a theme into the same-named folder. Choose a theme from https://themes.gohugo.io/, or create your own with the "hugo new theme " command. 2. Perhaps you want to add some content. You can add single files with "hugo new `) nextStepsText.WriteString(filepath.Join("", ".")) nextStepsText.WriteString(`". 3. Start the built-in live server via "hugo server". Visit https://gohugo.io/ for quickstart guide and full documentation.`) return nextStepsText.String() } // NewSite creates a new Hugo site and initializes a structured Hugo directory. func NewSite(cmd *cobra.Command, args []string) error { if len(args) < 1 { return newUserError("path needs to be provided") } createpath, err := filepath.Abs(filepath.Clean(args[0])) if err != nil { return newUserError(err) } forceNew, _ := cmd.Flags().GetBool("force") return doNewSite(createpath, forceNew) } // NewTheme creates a new Hugo theme. func NewTheme(cmd *cobra.Command, args []string) error { if err := InitializeConfig(); err != nil { return err } if len(args) < 1 { return newUserError("theme name needs to be provided") } createpath := helpers.AbsPathify(filepath.Join(viper.GetString("themesDir"), args[0])) jww.INFO.Println("creating theme at", createpath) if x, _ := helpers.Exists(createpath, hugofs.Source()); x { return newUserError(createpath, "already exists") } mkdir(createpath, "layouts", "_default") mkdir(createpath, "layouts", "partials") touchFile(createpath, "layouts", "index.html") touchFile(createpath, "layouts", "404.html") touchFile(createpath, "layouts", "_default", "list.html") touchFile(createpath, "layouts", "_default", "single.html") touchFile(createpath, "layouts", "partials", "header.html") touchFile(createpath, "layouts", "partials", "footer.html") mkdir(createpath, "archetypes") archDefault := []byte("+++\n+++\n") err := helpers.WriteToDisk(filepath.Join(createpath, "archetypes", "default.md"), bytes.NewReader(archDefault), hugofs.Source()) if err != nil { return err } mkdir(createpath, "static", "js") mkdir(createpath, "static", "css") by := []byte(`The MIT License (MIT) Copyright (c) ` + time.Now().Format("2006") + ` YOUR_NAME_HERE Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. `) err = helpers.WriteToDisk(filepath.Join(createpath, "LICENSE.md"), bytes.NewReader(by), hugofs.Source()) if err != nil { return err } createThemeMD(createpath) return nil } func mkdir(x ...string) { p := filepath.Join(x...) err := os.MkdirAll(p, 0777) // before umask if err != nil { jww.FATAL.Fatalln(err) } } func touchFile(x ...string) { inpath := filepath.Join(x...) mkdir(filepath.Dir(inpath)) err := helpers.WriteToDisk(inpath, bytes.NewReader([]byte{}), hugofs.Source()) if err != nil { jww.FATAL.Fatalln(err) } } func createThemeMD(inpath string) (err error) { by := []byte(`# theme.toml template for a Hugo theme # See https://github.com/spf13/hugoThemes#themetoml for an example name = "` + strings.Title(helpers.MakeTitle(filepath.Base(inpath))) + `" license = "MIT" licenselink = "https://github.com/yourname/yourtheme/blob/master/LICENSE.md" description = "" homepage = "http://siteforthistheme.com/" tags = ["", ""] features = ["", ""] min_version = 0.18 [author] name = "" homepage = "" # If porting an existing theme [original] name = "" homepage = "" repo = "" `) err = helpers.WriteToDisk(filepath.Join(inpath, "theme.toml"), bytes.NewReader(by), hugofs.Source()) if err != nil { return } return nil } func newContentPathSection(path string) (string, string) { // Forward slashes is used in all examples. Convert if needed. // Issue #1133 createpath := strings.Replace(path, "/", helpers.FilePathSeparator, -1) var section string // assume the first directory is the section (kind) if strings.Contains(createpath[1:], helpers.FilePathSeparator) { section = helpers.GuessSection(createpath) } return createpath, section } func createConfig(inpath string, kind string) (err error) { in := map[string]interface{}{ "baseurl": "http://example.org/", "title": "My New Hugo Site", "languageCode": "en-us", } kind = parser.FormatSanitize(kind) by, err := parser.InterfaceToConfig(in, parser.FormatToLeadRune(kind)) if err != nil { return err } err = helpers.WriteToDisk(filepath.Join(inpath, "config."+kind), bytes.NewReader(by), hugofs.Source()) if err != nil { return } return nil } hugo-0.18.1/commands/new_test.go000066400000000000000000000057071303124201100165170ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "os" "path/filepath" "testing" "github.com/spf13/hugo/hugofs" "github.com/stretchr/testify/assert" ) // Issue #1133 func TestNewContentPathSectionWithForwardSlashes(t *testing.T) { p, s := newContentPathSection("/post/new.md") assert.Equal(t, filepath.FromSlash("/post/new.md"), p) assert.Equal(t, "post", s) } func checkNewSiteInited(basepath string, t *testing.T) { paths := []string{ filepath.Join(basepath, "layouts"), filepath.Join(basepath, "content"), filepath.Join(basepath, "archetypes"), filepath.Join(basepath, "static"), filepath.Join(basepath, "data"), filepath.Join(basepath, "config.toml"), } for _, path := range paths { _, err := hugofs.Source().Stat(path) assert.Nil(t, err) } } func TestDoNewSite(t *testing.T) { basepath := filepath.Join(os.TempDir(), "blog") hugofs.InitMemFs() err := doNewSite(basepath, false) assert.Nil(t, err) checkNewSiteInited(basepath, t) } func TestDoNewSite_noerror_base_exists_but_empty(t *testing.T) { basepath := filepath.Join(os.TempDir(), "blog") hugofs.InitMemFs() hugofs.Source().MkdirAll(basepath, 777) err := doNewSite(basepath, false) assert.Nil(t, err) } func TestDoNewSite_error_base_exists(t *testing.T) { basepath := filepath.Join(os.TempDir(), "blog") hugofs.InitMemFs() hugofs.Source().MkdirAll(basepath, 777) hugofs.Source().Create(filepath.Join(basepath, "foo")) // Since the directory already exists and isn't empty, expect an error err := doNewSite(basepath, false) assert.NotNil(t, err) } func TestDoNewSite_force_empty_dir(t *testing.T) { basepath := filepath.Join(os.TempDir(), "blog") hugofs.InitMemFs() hugofs.Source().MkdirAll(basepath, 777) err := doNewSite(basepath, true) assert.Nil(t, err) checkNewSiteInited(basepath, t) } func TestDoNewSite_error_force_dir_inside_exists(t *testing.T) { basepath := filepath.Join(os.TempDir(), "blog") contentPath := filepath.Join(basepath, "content") hugofs.InitMemFs() hugofs.Source().MkdirAll(contentPath, 777) err := doNewSite(basepath, true) assert.NotNil(t, err) } func TestDoNewSite_error_force_config_inside_exists(t *testing.T) { basepath := filepath.Join(os.TempDir(), "blog") configPath := filepath.Join(basepath, "config.toml") hugofs.InitMemFs() hugofs.Source().MkdirAll(basepath, 777) hugofs.Source().Create(configPath) err := doNewSite(basepath, true) assert.NotNil(t, err) } hugo-0.18.1/commands/server.go000066400000000000000000000203631303124201100161700ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "fmt" "net" "net/http" "net/url" "os" "runtime" "strconv" "strings" "time" "mime" "github.com/spf13/afero" "github.com/spf13/cobra" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugofs" jww "github.com/spf13/jwalterweatherman" "github.com/spf13/viper" ) var ( disableLiveReload bool renderToDisk bool serverAppend bool serverInterface string serverPort int serverWatch bool ) //var serverCmdV *cobra.Command var serverCmd = &cobra.Command{ Use: "server", Aliases: []string{"serve"}, Short: "A high performance webserver", Long: `Hugo provides its own webserver which builds and serves the site. While hugo server is high performance, it is a webserver with limited options. Many run it in production, but the standard behavior is for people to use it in development and use a more full featured server such as Nginx or Caddy. 'hugo server' will avoid writing the rendered and served content to disk, preferring to store it in memory. By default hugo will also watch your files for any changes you make and automatically rebuild the site. It will then live reload any open browser pages and push the latest content to them. As most Hugo sites are built in a fraction of a second, you will be able to save and see your changes nearly instantly.`, //RunE: server, } type filesOnlyFs struct { fs http.FileSystem } type noDirFile struct { http.File } func (fs filesOnlyFs) Open(name string) (http.File, error) { f, err := fs.fs.Open(name) if err != nil { return nil, err } return noDirFile{f}, nil } func (f noDirFile) Readdir(count int) ([]os.FileInfo, error) { return nil, nil } func init() { initHugoBuilderFlags(serverCmd) serverCmd.Flags().IntVarP(&serverPort, "port", "p", 1313, "port on which the server will listen") serverCmd.Flags().StringVarP(&serverInterface, "bind", "", "127.0.0.1", "interface to which the server will bind") serverCmd.Flags().BoolVarP(&serverWatch, "watch", "w", true, "watch filesystem for changes and recreate as needed") serverCmd.Flags().BoolVarP(&serverAppend, "appendPort", "", true, "append port to baseURL") serverCmd.Flags().BoolVar(&disableLiveReload, "disableLiveReload", false, "watch without enabling live browser reload on rebuild") serverCmd.Flags().BoolVar(&renderToDisk, "renderToDisk", false, "render to Destination path (default is render to memory & serve from there)") serverCmd.Flags().String("memstats", "", "log memory usage to this file") serverCmd.Flags().String("meminterval", "100ms", "interval to poll memory usage (requires --memstats), valid time units are \"ns\", \"us\" (or \"µs\"), \"ms\", \"s\", \"m\", \"h\".") serverCmd.RunE = server mime.AddExtensionType(".json", "application/json; charset=utf-8") mime.AddExtensionType(".css", "text/css; charset=utf-8") } func server(cmd *cobra.Command, args []string) error { if err := InitializeConfig(serverCmd); err != nil { return err } if flagChanged(cmd.Flags(), "disableLiveReload") { viper.Set("disableLiveReload", disableLiveReload) } if serverWatch { viper.Set("watch", true) } if viper.GetBool("watch") { serverWatch = true watchConfig() } l, err := net.Listen("tcp", net.JoinHostPort(serverInterface, strconv.Itoa(serverPort))) if err == nil { l.Close() } else { if flagChanged(serverCmd.Flags(), "port") { // port set explicitly by user -- he/she probably meant it! return newSystemErrorF("Server startup failed: %s", err) } jww.ERROR.Println("port", serverPort, "already in use, attempting to use an available port") sp, err := helpers.FindAvailablePort() if err != nil { return newSystemError("Unable to find alternative port to use:", err) } serverPort = sp.Port } viper.Set("port", serverPort) baseURL, err = fixURL(baseURL) if err != nil { return err } viper.Set("baseURL", baseURL) if err := memStats(); err != nil { jww.ERROR.Println("memstats error:", err) } // If a Destination is provided via flag write to disk if destination != "" { renderToDisk = true } // Hugo writes the output to memory instead of the disk if !renderToDisk { hugofs.SetDestination(new(afero.MemMapFs)) // Rendering to memoryFS, publish to Root regardless of publishDir. viper.Set("publishDir", "/") } if err := build(serverWatch); err != nil { return err } // Watch runs its own server as part of the routine if serverWatch { watchDirs := getDirList() baseWatchDir := viper.GetString("workingDir") for i, dir := range watchDirs { watchDirs[i], _ = helpers.GetRelativePath(dir, baseWatchDir) } rootWatchDirs := strings.Join(helpers.UniqueStrings(helpers.ExtractRootPaths(watchDirs)), ",") jww.FEEDBACK.Printf("Watching for changes in %s%s{%s}\n", baseWatchDir, helpers.FilePathSeparator, rootWatchDirs) err := NewWatcher(serverPort) if err != nil { return err } } serve(serverPort) return nil } func serve(port int) { if renderToDisk { jww.FEEDBACK.Println("Serving pages from " + helpers.AbsPathify(viper.GetString("publishDir"))) } else { jww.FEEDBACK.Println("Serving pages from memory") } httpFs := afero.NewHttpFs(hugofs.Destination()) fs := filesOnlyFs{httpFs.Dir(helpers.AbsPathify(viper.GetString("publishDir")))} fileserver := http.FileServer(fs) // We're only interested in the path u, err := url.Parse(viper.GetString("baseURL")) if err != nil { jww.ERROR.Fatalf("Invalid baseURL: %s", err) } if u.Path == "" || u.Path == "/" { http.Handle("/", fileserver) } else { http.Handle(u.Path, http.StripPrefix(u.Path, fileserver)) } jww.FEEDBACK.Printf("Web Server is available at %s (bind address %s)\n", u.String(), serverInterface) jww.FEEDBACK.Println("Press Ctrl+C to stop") endpoint := net.JoinHostPort(serverInterface, strconv.Itoa(port)) err = http.ListenAndServe(endpoint, nil) if err != nil { jww.ERROR.Printf("Error: %s\n", err.Error()) os.Exit(1) } } // fixURL massages the baseURL into a form needed for serving // all pages correctly. func fixURL(s string) (string, error) { useLocalhost := false if s == "" { s = viper.GetString("baseURL") useLocalhost = true } if !strings.HasSuffix(s, "/") { s = s + "/" } // do an initial parse of the input string u, err := url.Parse(s) if err != nil { return "", err } // if no Host is defined, then assume that no schema or double-slash were // present in the url. Add a double-slash and make a best effort attempt. if u.Host == "" && s != "/" { s = "//" + s u, err = url.Parse(s) if err != nil { return "", err } } if useLocalhost { if u.Scheme == "https" { u.Scheme = "http" } u.Host = "localhost" } if serverAppend { if strings.Contains(u.Host, ":") { u.Host, _, err = net.SplitHostPort(u.Host) if err != nil { return "", fmt.Errorf("Failed to split baseURL hostpost: %s", err) } } u.Host += fmt.Sprintf(":%d", serverPort) } return u.String(), nil } func memStats() error { memstats := serverCmd.Flags().Lookup("memstats").Value.String() if memstats != "" { interval, err := time.ParseDuration(serverCmd.Flags().Lookup("meminterval").Value.String()) if err != nil { interval, _ = time.ParseDuration("100ms") } fileMemStats, err := os.Create(memstats) if err != nil { return err } fileMemStats.WriteString("# Time\tHeapSys\tHeapAlloc\tHeapIdle\tHeapReleased\n") go func() { var stats runtime.MemStats start := time.Now().UnixNano() for { runtime.ReadMemStats(&stats) if fileMemStats != nil { fileMemStats.WriteString(fmt.Sprintf("%d\t%d\t%d\t%d\t%d\n", (time.Now().UnixNano()-start)/1000000, stats.HeapSys, stats.HeapAlloc, stats.HeapIdle, stats.HeapReleased)) time.Sleep(interval) } else { break } } }() } return nil } hugo-0.18.1/commands/server_test.go000066400000000000000000000041561303124201100172310ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "testing" "github.com/spf13/viper" ) func TestFixURL(t *testing.T) { defer viper.Reset() type data struct { TestName string CLIBaseURL string CfgBaseURL string AppendPort bool Port int Result string } tests := []data{ {"Basic http localhost", "", "http://foo.com", true, 1313, "http://localhost:1313/"}, {"Basic https production, http localhost", "", "https://foo.com", true, 1313, "http://localhost:1313/"}, {"Basic subdir", "", "http://foo.com/bar", true, 1313, "http://localhost:1313/bar/"}, {"Basic production", "http://foo.com", "http://foo.com", false, 80, "http://foo.com/"}, {"Production subdir", "http://foo.com/bar", "http://foo.com/bar", false, 80, "http://foo.com/bar/"}, {"No http", "", "foo.com", true, 1313, "//localhost:1313/"}, {"Override configured port", "", "foo.com:2020", true, 1313, "//localhost:1313/"}, {"No http production", "foo.com", "foo.com", false, 80, "//foo.com/"}, {"No http production with port", "foo.com", "foo.com", true, 2020, "//foo.com:2020/"}, {"No config", "", "", true, 1313, "//localhost:1313/"}, } for i, test := range tests { viper.Reset() baseURL = test.CLIBaseURL viper.Set("baseURL", test.CfgBaseURL) serverAppend = test.AppendPort serverPort = test.Port result, err := fixURL(baseURL) if err != nil { t.Errorf("Test #%d %s: unexpected error %s", i, test.TestName, err) } if result != test.Result { t.Errorf("Test #%d %s: expected %q, got %q", i, test.TestName, test.Result, result) } } } hugo-0.18.1/commands/undraft.go000066400000000000000000000104471303124201100163270ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "bytes" "errors" "os" "time" "github.com/spf13/cobra" "github.com/spf13/hugo/hugofs" "github.com/spf13/hugo/parser" ) var undraftCmd = &cobra.Command{ Use: "undraft path/to/content", Short: "Undraft changes the content's draft status from 'True' to 'False'", Long: `Undraft changes the content's draft status from 'True' to 'False' and updates the date to the current date and time. If the content's draft status is 'False', nothing is done.`, RunE: Undraft, } // Undraft publishes the specified content by setting its draft status // to false and setting its publish date to now. If the specified content is // not a draft, it will log an error. func Undraft(cmd *cobra.Command, args []string) error { if err := InitializeConfig(); err != nil { return err } if len(args) < 1 { return newUserError("a piece of content needs to be specified") } location := args[0] // open the file f, err := hugofs.Source().Open(location) if err != nil { return err } // get the page from file p, err := parser.ReadFrom(f) f.Close() if err != nil { return err } w, err := undraftContent(p) if err != nil { return newSystemErrorF("an error occurred while undrafting %q: %s", location, err) } f, err = hugofs.Source().OpenFile(location, os.O_WRONLY|os.O_TRUNC, 0644) if err != nil { return newSystemErrorF("%q not be undrafted due to error opening file to save changes: %q\n", location, err) } defer f.Close() _, err = w.WriteTo(f) if err != nil { return newSystemErrorF("%q not be undrafted due to save error: %q\n", location, err) } return nil } // undraftContent: if the content is a draft, change its draft status to // 'false' and set the date to time.Now(). If the draft status is already // 'false', don't do anything. func undraftContent(p parser.Page) (bytes.Buffer, error) { var buff bytes.Buffer // get the metadata; easiest way to see if it's a draft meta, err := p.Metadata() if err != nil { return buff, err } // since the metadata was obtainable, we can also get the key/value separator for // Front Matter fm := p.FrontMatter() if fm == nil { return buff, errors.New("Front Matter was found, nothing was finalized") } var isDraft, gotDate bool var date string L: for k, v := range meta.(map[string]interface{}) { switch k { case "draft": if !v.(bool) { return buff, errors.New("not a Draft: nothing was done") } isDraft = true if gotDate { break L } case "date": date = v.(string) // capture the value to make replacement easier gotDate = true if isDraft { break L } } } // if draft wasn't found in FrontMatter, it isn't a draft. if !isDraft { return buff, errors.New("not a Draft: nothing was done") } // get the front matter as bytes and split it into lines var lineEnding []byte fmLines := bytes.Split(fm, []byte("\n")) if len(fmLines) == 1 { // if the result is only 1 element, try to split on dos line endings fmLines = bytes.Split(fm, []byte("\r\n")) if len(fmLines) == 1 { return buff, errors.New("unable to split FrontMatter into lines") } lineEnding = append(lineEnding, []byte("\r\n")...) } else { lineEnding = append(lineEnding, []byte("\n")...) } // Write the front matter lines to the buffer, replacing as necessary for _, v := range fmLines { pos := bytes.Index(v, []byte("draft")) if pos != -1 { v = bytes.Replace(v, []byte("true"), []byte("false"), 1) goto write } pos = bytes.Index(v, []byte("date")) if pos != -1 { // if date field wasn't found, add it v = bytes.Replace(v, []byte(date), []byte(time.Now().Format(time.RFC3339)), 1) } write: buff.Write(v) buff.Write(lineEnding) } // append the actual content buff.Write(p.Content()) return buff, nil } hugo-0.18.1/commands/undraft_test.go000066400000000000000000000046541303124201100173710ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands // TODO Support Mac Encoding (\r) import ( "bytes" "strings" "testing" "time" "github.com/spf13/hugo/parser" ) var ( jsonFM = "{\n \"date\": \"12-04-06\",\n \"title\": \"test json\"\n}" jsonDraftFM = "{\n \"draft\": true,\n \"date\": \"12-04-06\",\n \"title\":\"test json\"\n}" tomlFM = "+++\n date= \"12-04-06\"\n title= \"test toml\"\n+++" tomlDraftFM = "+++\n draft= true\n date= \"12-04-06\"\n title=\"test toml\"\n+++" yamlFM = "---\n date: \"12-04-06\"\n title: \"test yaml\"\n---" yamlDraftFM = "---\n draft: true\n date: \"12-04-06\"\n title: \"test yaml\"\n---" ) func TestUndraftContent(t *testing.T) { tests := []struct { fm string expectedErr string }{ {jsonFM, "not a Draft: nothing was done"}, {jsonDraftFM, ""}, {tomlFM, "not a Draft: nothing was done"}, {tomlDraftFM, ""}, {yamlFM, "not a Draft: nothing was done"}, {yamlDraftFM, ""}, } for _, test := range tests { r := bytes.NewReader([]byte(test.fm)) p, _ := parser.ReadFrom(r) res, err := undraftContent(p) if test.expectedErr != "" { if err == nil { t.Error("Expected error, got none") continue } if err.Error() != test.expectedErr { t.Errorf("Expected %q, got %q", test.expectedErr, err) continue } } else { r = bytes.NewReader(res.Bytes()) p, _ = parser.ReadFrom(r) meta, err := p.Metadata() if err != nil { t.Errorf("unexpected error %q", err) continue } for k, v := range meta.(map[string]interface{}) { if k == "draft" { if v.(bool) { t.Errorf("Expected %q to be \"false\", got \"true\"", k) continue } } if k == "date" { if !strings.HasPrefix(v.(string), time.Now().Format("2006-01-02")) { t.Errorf("Expected %v to start with %v", v.(string), time.Now().Format("2006-01-02")) } } } } } } hugo-0.18.1/commands/version.go000066400000000000000000000047041303124201100163500ustar00rootroot00000000000000// Copyright 2015 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package commands import ( "os" "path/filepath" "strings" "time" "github.com/kardianos/osext" "github.com/spf13/cobra" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugolib" jww "github.com/spf13/jwalterweatherman" ) var versionCmd = &cobra.Command{ Use: "version", Short: "Print the version number of Hugo", Long: `All software has versions. This is Hugo's.`, RunE: func(cmd *cobra.Command, args []string) error { printHugoVersion() return nil }, } func printHugoVersion() { if hugolib.BuildDate == "" { setBuildDate() // set the build date from executable's mdate } else { formatBuildDate() // format the compile time } if hugolib.CommitHash == "" { jww.FEEDBACK.Printf("Hugo Static Site Generator v%s BuildDate: %s\n", helpers.HugoVersion(), hugolib.BuildDate) } else { jww.FEEDBACK.Printf("Hugo Static Site Generator v%s-%s BuildDate: %s\n", helpers.HugoVersion(), strings.ToUpper(hugolib.CommitHash), hugolib.BuildDate) } } // setBuildDate checks the ModTime of the Hugo executable and returns it as a // formatted string. This assumes that the executable name is Hugo, if it does // not exist, an empty string will be returned. This is only called if the // hugolib.BuildDate wasn't set during compile time. // // osext is used for cross-platform. func setBuildDate() { fname, _ := osext.Executable() dir, err := filepath.Abs(filepath.Dir(fname)) if err != nil { jww.ERROR.Println(err) return } fi, err := os.Lstat(filepath.Join(dir, filepath.Base(fname))) if err != nil { jww.ERROR.Println(err) return } t := fi.ModTime() hugolib.BuildDate = t.Format(time.RFC3339) } // formatBuildDate formats the hugolib.BuildDate according to the value in // .Params.DateFormat, if it's set. func formatBuildDate() { t, _ := time.Parse("2006-01-02T15:04:05-0700", hugolib.BuildDate) hugolib.BuildDate = t.Format(time.RFC3339) } hugo-0.18.1/create/000077500000000000000000000000001303124201100137715ustar00rootroot00000000000000hugo-0.18.1/create/content.go000066400000000000000000000116241303124201100157760ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. // Package create provides functions to create new content. package create import ( "bytes" "os" "os/exec" "path" "path/filepath" "strings" "time" "github.com/spf13/afero" "github.com/spf13/cast" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugolib" "github.com/spf13/hugo/parser" jww "github.com/spf13/jwalterweatherman" "github.com/spf13/viper" ) // NewContent creates a new content file in the content directory based upon the // given kind, which is used to lookup an archetype. func NewContent(fs afero.Fs, kind, name string) (err error) { jww.INFO.Println("attempting to create ", name, "of", kind) location := FindArchetype(fs, kind) var by []byte if location != "" { by, err = afero.ReadFile(fs, location) if err != nil { jww.ERROR.Println(err) } } if location == "" || err != nil { by = []byte("+++\ndraft = true \n+++\n") } psr, err := parser.ReadFrom(bytes.NewReader(by)) if err != nil { return err } metadata, err := createMetadata(psr, name) if err != nil { jww.ERROR.Printf("Error processing archetype file %s: %s\n", location, err) return err } page, err := hugolib.NewPage(name) if err != nil { return err } if err = page.SetSourceMetaData(metadata, parser.FormatToLeadRune(viper.GetString("metaDataFormat"))); err != nil { return } page.SetSourceContent(psr.Content()) if err = page.SafeSaveSourceAs(filepath.Join(viper.GetString("contentDir"), name)); err != nil { return } jww.FEEDBACK.Println(helpers.AbsPathify(filepath.Join(viper.GetString("contentDir"), name)), "created") editor := viper.GetString("newContentEditor") if editor != "" { jww.FEEDBACK.Printf("Editing %s with %q ...\n", name, editor) cmd := exec.Command(editor, helpers.AbsPathify(path.Join(viper.GetString("contentDir"), name))) cmd.Stdin = os.Stdin cmd.Stdout = os.Stdout cmd.Stderr = os.Stderr return cmd.Run() } return nil } // createMetadata generates Metadata for a new page based upon the metadata // found in an archetype. func createMetadata(archetype parser.Page, name string) (map[string]interface{}, error) { archMetadata, err := archetype.Metadata() if err != nil { return nil, err } metadata, err := cast.ToStringMapE(archMetadata) if err != nil { return nil, err } var date time.Time for k, v := range metadata { if v == "" { continue } lk := strings.ToLower(k) switch lk { case "date": date, err = cast.ToTimeE(v) if err != nil { return nil, err } case "title": // Use the archetype title as is metadata[lk] = v } } if metadata == nil { metadata = make(map[string]interface{}) } if date.IsZero() { date = time.Now() } if _, ok := metadata["title"]; !ok { metadata["title"] = helpers.MakeTitle(helpers.Filename(name)) } // TOD(bep) what is this? if x := parser.FormatSanitize(viper.GetString("metaDataFormat")); x == "json" || x == "yaml" || x == "toml" { metadata["date"] = date.Format(time.RFC3339) } else { metadata["date"] = date } return metadata, nil } // FindArchetype takes a given kind/archetype of content and returns an output // path for that archetype. If no archetype is found, an empty string is // returned. func FindArchetype(fs afero.Fs, kind string) (outpath string) { search := []string{helpers.AbsPathify(viper.GetString("archetypeDir"))} if viper.GetString("theme") != "" { themeDir := filepath.Join(helpers.AbsPathify(viper.GetString("themesDir")+"/"+viper.GetString("theme")), "/archetypes/") if _, err := fs.Stat(themeDir); os.IsNotExist(err) { jww.ERROR.Printf("Unable to find archetypes directory for theme %q at %q", viper.GetString("theme"), themeDir) } else { search = append(search, themeDir) } } for _, x := range search { // If the new content isn't in a subdirectory, kind == "". // Therefore it should be excluded otherwise `is a directory` // error will occur. github.com/spf13/hugo/issues/411 var pathsToCheck []string if kind == "" { pathsToCheck = []string{"default.md", "default"} } else { pathsToCheck = []string{kind + ".md", kind, "default.md", "default"} } for _, p := range pathsToCheck { curpath := filepath.Join(x, p) jww.DEBUG.Println("checking", curpath, "for archetypes") if exists, _ := helpers.Exists(curpath, fs); exists { jww.INFO.Println("curpath: " + curpath) return curpath } } } return "" } hugo-0.18.1/create/content_test.go000066400000000000000000000073451303124201100170420ustar00rootroot00000000000000// Copyright 2016 The Hugo Authors. All rights reserved. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. package create_test import ( "os" "path/filepath" "strings" "testing" "fmt" "github.com/spf13/afero" "github.com/spf13/hugo/create" "github.com/spf13/hugo/helpers" "github.com/spf13/hugo/hugofs" "github.com/spf13/viper" ) func TestNewContent(t *testing.T) { initViper() err := initFs() if err != nil { t.Fatalf("initialization error: %s", err) } cases := []struct { kind string path string expected []string }{ {"post", "post/sample-1.md", []string{`title = "Post Arch title"`, `test = "test1"`, "date = \"2015-01-12T19:20:04-07:00\""}}, {"emptydate", "post/sample-ed.md", []string{`title = "Empty Date Arch title"`, `test = "test1"`}}, {"stump", "stump/sample-2.md", []string{`title = "sample 2"`}}, // no archetype file {"", "sample-3.md", []string{`title = "sample 3"`}}, // no archetype {"product", "product/sample-4.md", []string{`title = "sample 4"`}}, // empty archetype front matter } for i, c := range cases { err = create.NewContent(hugofs.Source(), c.kind, c.path) if err != nil { t.Errorf("[%d] NewContent: %s", i, err) } fname := filepath.Join("content", filepath.FromSlash(c.path)) content := readFileFromFs(t, hugofs.Source(), fname) for i, v := range c.expected { found := strings.Contains(content, v) if !found { t.Errorf("[%d] %q missing from output:\n%q", i, v, content) } } } } func initViper() { viper.Reset() viper.Set("metaDataFormat", "toml") viper.Set("archetypeDir", "archetypes") viper.Set("contentDir", "content") viper.Set("themesDir", "themes") viper.Set("theme", "sample") } func initFs() error { hugofs.InitMemFs() perm := os.FileMode(0755) var err error // create directories dirs := []string{ "archetypes", "content", filepath.Join("themes", "sample", "archetypes"), } for _, dir := range dirs { err = hugofs.Source().Mkdir(dir, perm) if err != nil { return err } } // create files for _, v := range []struct { path string content string }{ { path: filepath.Join("archetypes", "post.md"), content: "+++\ndate = \"2015-01-12T19:20:04-07:00\"\ntitle = \"Post Arch title\"\ntest = \"test1\"\n+++\n", }, { path: filepath.Join("archetypes", "product.md"), content: "+++\n+++\n", }, { path: filepath.Join("archetypes", "emptydate.md"), content: "+++\ndate =\"\"\ntitle = \"Empty Date Arch title\"\ntest = \"test1\"\n+++\n", }, } { f, err := hugofs.Source().Create(v.path) if err != nil { return err } defer f.Close() _, err = f.Write([]byte(v.content)) if err != nil { return err } } return nil } // TODO(bep) extract common testing package with this and some others func readFileFromFs(t *testing.T, fs afero.Fs, filename string) string { filename = filepath.FromSlash(filename) b, err := afero.ReadFile(fs, filename) if err != nil { // Print some debug info root := strings.Split(filename, helpers.FilePathSeparator)[0] afero.Walk(fs, root, func(path string, info os.FileInfo, err error) error { if info != nil && !info.IsDir() { fmt.Println(" ", path) } return nil }) t.Fatalf("Failed to read file: %s", err) } return string(b) } hugo-0.18.1/docs/000077500000000000000000000000001303124201100134565ustar00rootroot00000000000000hugo-0.18.1/docs/.gitignore000066400000000000000000000000071303124201100154430ustar00rootroot00000000000000/.idea hugo-0.18.1/docs/archetypes/000077500000000000000000000000001303124201100156255ustar00rootroot00000000000000hugo-0.18.1/docs/archetypes/default.md000066400000000000000000000000711303124201100175710ustar00rootroot00000000000000+++ weight = 5 [menu] [menu.main] parent = "x" +++ hugo-0.18.1/docs/archetypes/showcase.md000066400000000000000000000003411303124201100177610ustar00rootroot00000000000000--- date: 2013-07-01T07:32:00Z description: "" license: "" licenseLink: "" sitelink: http://spf13.com/ sourceLink: https://github.com/spf13/spf13.com tags: - personal - blog thumbnail: /img/spf13-tn.jpg title: spf13.com --- hugo-0.18.1/docs/config.toml000066400000000000000000000054741303124201100156320ustar00rootroot00000000000000title = "Hugo: A Fast and Flexible Website Generator" baseurl = "http://gohugo.io/" MetaDataFormat = "yaml" pluralizeListTitles = false enableGitInfo = true [blackfriday] plainIDAnchors = true [params] description = "Documentation of Hugo, a fast and flexible static site generator built with love by spf13, bep and friends in Go" author = "Steve Francia (spf13) and friends" [taxonomies] tag = "tags" group = "groups" [[menu.main]] name = "Download Hugo" pre = "" url = "https://github.com/spf13/hugo/releases" weight = -200 [[menu.main]] name = "Site Showcase" pre = "" url = "/showcase/" weight = -180 [[menu.main]] name = "Theme Showcase" pre = "" url = "http://themes.gohugo.io" weight = -170 [[menu.main]] name = "Press & Articles" pre = "" url = "/community/press/" weight = -160 [[menu.main]] name = "Discuss Hugo" pre = "" url = "http://discuss.gohugo.io/" weight = -150 [[menu.main]] name = "About Hugo" identifier = "about" pre = "" weight = -110 [[menu.main]] name = "Getting Started" identifier = "getting started" pre = "" weight = -100 [[menu.main]] name = "Content" identifier = "content" pre = "" weight = -90 [[menu.main]] name = "Themes" identifier = "themes" pre = "" weight = -85 [[menu.main]] parent = "themes" name = "Theme Showcase" url = "http://themes.gohugo.io" weight = -170 [[menu.main]] name = "Templates" identifier = "layout" pre = "" weight = -80 [[menu.main]] name = "Taxonomies" identifier = "taxonomy" pre = "" weight = -70 [[menu.main]] name = "Extras" identifier = "extras" pre = "" weight = -60 [[menu.main]] name = "Community" identifier = "community" pre = "" weight = -50 [[menu.main]] parent = "community" name = "Discussion Forum" url = "http://discuss.gohugo.io" weight = 150 [[menu.main]] name = "Tutorials" identifier = "tutorials" pre = "" weight = -40 [[menu.main]] name = "Troubleshooting" identifier = "troubleshooting" pre = "" weight = -30 [[menu.main]] name = "Tools" url = "/tools/" pre = "" weight = -25 [[menu.main]] name = "Hugo Cmd Reference" identifier = "commands" pre = "" weight = -20 url = "/commands/" hugo-0.18.1/docs/content/000077500000000000000000000000001303124201100151305ustar00rootroot00000000000000hugo-0.18.1/docs/content/commands/000077500000000000000000000000001303124201100167315ustar00rootroot00000000000000hugo-0.18.1/docs/content/commands/hugo.md000066400000000000000000000071651303124201100202260ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo" slug: hugo url: /commands/hugo/ --- ## hugo hugo builds your site ### Synopsis hugo is the main command, used to build your Hugo site. Hugo is a Fast and Flexible Static Site Generator built with love by spf13 and friends in Go. Complete documentation is available at http://gohugo.io/. ``` hugo ``` ### Options ``` -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ -D, --buildDrafts include content marked as draft -E, --buildExpired include expired content -F, --buildFuture include content with publishdate in the future --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL --cleanDestinationDir Remove files from destination not found in static directories --config string config file (default is path/config.yaml|json|toml) -c, --contentDir string filesystem path to content directory -d, --destination string filesystem path to write files to --disable404 Do not render 404 page --disableRSS Do not build RSS files --disableSitemap Do not build Sitemap file --forceSyncStatic Copy all files when static is changed. --i18n-warnings Print missing translations --ignoreCache Ignores the cache directory -l, --layoutDir string filesystem path to layout directory --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) --noChmod Don't sync permission mode of files --noTimes Don't sync modification time of files --pluralizeListTitles Pluralize titles in lists using inflect (default true) --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --renderToMemory render to memory (only useful for benchmark testing) -s, --source string filesystem path to read files relative from --stepAnalysis display memory and timing of different steps of the program -t, --theme string theme to use (located in /themes/THEMENAME/) --uglyURLs if true, use /filename.html instead of /filename/ -v, --verbose verbose output --verboseLog verbose logging -w, --watch watch filesystem for changes and recreate as needed ``` ### SEE ALSO * [hugo benchmark](/commands/hugo_benchmark/) - Benchmark Hugo by building a site a number of times. * [hugo check](/commands/hugo_check/) - Check content in the source directory * [hugo config](/commands/hugo_config/) - Print the site configuration * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats * [hugo env](/commands/hugo_env/) - Print Hugo version and environment info * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. * [hugo import](/commands/hugo_import/) - Import your site from others. * [hugo list](/commands/hugo_list/) - Listing out various types of content * [hugo new](/commands/hugo_new/) - Create new content for your site * [hugo server](/commands/hugo_server/) - A high performance webserver * [hugo undraft](/commands/hugo_undraft/) - Undraft changes the content's draft status from 'True' to 'False' * [hugo version](/commands/hugo_version/) - Print the version number of Hugo ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_benchmark.md000066400000000000000000000055201303124201100222310ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo benchmark" slug: hugo_benchmark url: /commands/hugo_benchmark/ --- ## hugo benchmark Benchmark Hugo by building a site a number of times. ### Synopsis Hugo can build a site many times over and analyze the running process creating a benchmark. ``` hugo benchmark ``` ### Options ``` -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ -D, --buildDrafts include content marked as draft -E, --buildExpired include expired content -F, --buildFuture include content with publishdate in the future --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL --cleanDestinationDir Remove files from destination not found in static directories -c, --contentDir string filesystem path to content directory -n, --count int number of times to build the site (default 13) --cpuprofile string path/filename for the CPU profile file -d, --destination string filesystem path to write files to --disable404 Do not render 404 page --disableRSS Do not build RSS files --disableSitemap Do not build Sitemap file --forceSyncStatic Copy all files when static is changed. --i18n-warnings Print missing translations --ignoreCache Ignores the cache directory -l, --layoutDir string filesystem path to layout directory --memprofile string path/filename for the memory profile file --noChmod Don't sync permission mode of files --noTimes Don't sync modification time of files --pluralizeListTitles Pluralize titles in lists using inflect (default true) --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --renderToMemory render to memory (only useful for benchmark testing) -s, --source string filesystem path to read files relative from --stepAnalysis display memory and timing of different steps of the program -t, --theme string theme to use (located in /themes/THEMENAME/) --uglyURLs if true, use /filename.html instead of /filename/ ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_check.md000066400000000000000000000050021303124201100213470ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo check" slug: hugo_check url: /commands/hugo_check/ --- ## hugo check Check content in the source directory ### Synopsis Hugo will perform some basic analysis on the content provided and will give feedback. ``` hugo check ``` ### Options ``` -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ -D, --buildDrafts include content marked as draft -E, --buildExpired include expired content -F, --buildFuture include content with publishdate in the future --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL --cleanDestinationDir Remove files from destination not found in static directories -c, --contentDir string filesystem path to content directory -d, --destination string filesystem path to write files to --disable404 Do not render 404 page --disableRSS Do not build RSS files --disableSitemap Do not build Sitemap file --forceSyncStatic Copy all files when static is changed. --i18n-warnings Print missing translations --ignoreCache Ignores the cache directory -l, --layoutDir string filesystem path to layout directory --noTimes Don't sync modification time of files --pluralizeListTitles Pluralize titles in lists using inflect (default true) --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") -s, --source string filesystem path to read files relative from --stepAnalysis display memory and timing of different steps of the program -t, --theme string theme to use (located in /themes/THEMENAME/) --uglyURLs if true, use /filename.html instead of /filename/ ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site * [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_check_ulimit.md000066400000000000000000000014741303124201100227430ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo check ulimit" slug: hugo_check_ulimit url: /commands/hugo_check_ulimit/ --- ## hugo check ulimit Check system ulimit settings ### Synopsis Hugo will inspect the current ulimit settings on the system. This is primarily to ensure that Hugo can watch enough files on some OSs ``` hugo check ulimit ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo check](/commands/hugo_check/) - Check content in the source directory ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_config.md000066400000000000000000000012741303124201100215460ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo config" slug: hugo_config url: /commands/hugo_config/ --- ## hugo config Print the site configuration ### Synopsis Print the site configuration, both default and custom settings. ``` hugo config ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_convert.md000066400000000000000000000023471303124201100217630ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo convert" slug: hugo_convert url: /commands/hugo_convert/ --- ## hugo convert Convert your content to different formats ### Synopsis Convert your content (e.g. front matter) to different formats. See convert's subcommands toJSON, toTOML and toYAML for more information. ### Options ``` -o, --output string filesystem path to write files to -s, --source string filesystem path to read files relative from --unsafe enable less safe operations, please backup first ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site * [hugo convert toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON * [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML * [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_convert_toJSON.md000066400000000000000000000017561303124201100231620ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo convert toJSON" slug: hugo_convert_toJSON url: /commands/hugo_convert_tojson/ --- ## hugo convert toJSON Convert front matter to JSON ### Synopsis toJSON converts all front matter in the content directory to use JSON for the front matter. ``` hugo convert toJSON ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to -s, --source string filesystem path to read files relative from --unsafe enable less safe operations, please backup first -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_convert_toTOML.md000066400000000000000000000017561303124201100231640ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo convert toTOML" slug: hugo_convert_toTOML url: /commands/hugo_convert_totoml/ --- ## hugo convert toTOML Convert front matter to TOML ### Synopsis toTOML converts all front matter in the content directory to use TOML for the front matter. ``` hugo convert toTOML ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to -s, --source string filesystem path to read files relative from --unsafe enable less safe operations, please backup first -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_convert_toYAML.md000066400000000000000000000017561303124201100231530ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo convert toYAML" slug: hugo_convert_toYAML url: /commands/hugo_convert_toyaml/ --- ## hugo convert toYAML Convert front matter to YAML ### Synopsis toYAML converts all front matter in the content directory to use YAML for the front matter. ``` hugo convert toYAML ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -o, --output string filesystem path to write files to -s, --source string filesystem path to read files relative from --unsafe enable less safe operations, please backup first -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_env.md000066400000000000000000000013051303124201100210640ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo env" slug: hugo_env url: /commands/hugo_env/ --- ## hugo env Print Hugo version and environment info ### Synopsis Print Hugo version and environment info. This is useful in Hugo bug reports. ``` hugo env ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_gen.md000066400000000000000000000016611303124201100210520ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo gen" slug: hugo_gen url: /commands/hugo_gen/ --- ## hugo gen A collection of several useful generators. ### Synopsis A collection of several useful generators. ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site * [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo * [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI. * [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_gen_autocomplete.md000066400000000000000000000026761303124201100236420ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo gen autocomplete" slug: hugo_gen_autocomplete url: /commands/hugo_gen_autocomplete/ --- ## hugo gen autocomplete Generate shell autocompletion script for Hugo ### Synopsis Generates a shell autocompletion script for Hugo. NOTE: The current version supports Bash only. This should work for *nix systems with Bash installed. By default, the file is written directly to /etc/bash_completion.d for convenience, and the command may need superuser rights, e.g.: $ sudo hugo gen autocomplete Add `--completionfile=/path/to/file` flag to set alternative file-path and name. Logout and in again to reload the completion scripts, or just source them in directly: $ . /etc/bash_completion ``` hugo gen autocomplete ``` ### Options ``` --completionfile string Autocompletion file (default "/etc/bash_completion.d/hugo.sh") --type string Autocompletion type (currently only bash supported) (default "bash") ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_gen_doc.md000066400000000000000000000020401303124201100216670ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo gen doc" slug: hugo_gen_doc url: /commands/hugo_gen_doc/ --- ## hugo gen doc Generate Markdown documentation for the Hugo CLI. ### Synopsis Generate Markdown documentation for the Hugo CLI. This command is, mostly, used to create up-to-date documentation of Hugo's command-line interface for http://gohugo.io/. It creates one Markdown file per command with front matter suitable for rendering in Hugo. ``` hugo gen doc ``` ### Options ``` --dir string the directory to write the doc. (default "/tmp/hugodoc/") ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_gen_man.md000066400000000000000000000017021303124201100217010ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo gen man" slug: hugo_gen_man url: /commands/hugo_gen_man/ --- ## hugo gen man Generate man pages for the Hugo CLI ### Synopsis This command automatically generates up-to-date man pages of Hugo's command-line interface. By default, it creates the man page files in the "man" directory under the current directory. ``` hugo gen man ``` ### Options ``` --dir string the directory to write the man pages. (default "man/") ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_import.md000066400000000000000000000015151303124201100216110ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo import" slug: hugo_import url: /commands/hugo_import/ --- ## hugo import Import your site from others. ### Synopsis Import your site from other web site generators like Jekyll. Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site * [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_import_jekyll.md000066400000000000000000000015741303124201100231700ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo import jekyll" slug: hugo_import_jekyll url: /commands/hugo_import_jekyll/ --- ## hugo import jekyll hugo import from Jekyll ### Synopsis hugo import from Jekyll. Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`. ``` hugo import jekyll ``` ### Options ``` --force Allow import into non-empty target directory ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo import](/commands/hugo_import/) - Import your site from others. ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_list.md000066400000000000000000000020201303124201100212420ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo list" slug: hugo_list url: /commands/hugo_list/ --- ## hugo list Listing out various types of content ### Synopsis Listing out various types of content. List requires a subcommand, e.g. `hugo list drafts`. ### Options ``` -s, --source string filesystem path to read files relative from ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site * [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts * [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired * [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_list_drafts.md000066400000000000000000000014301303124201100226110ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo list drafts" slug: hugo_list_drafts url: /commands/hugo_list_drafts/ --- ## hugo list drafts List all drafts ### Synopsis List all of the drafts in your content directory. ``` hugo list drafts ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -s, --source string filesystem path to read files relative from -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_list_expired.md000066400000000000000000000015051303124201100227710ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo list expired" slug: hugo_list_expired url: /commands/hugo_list_expired/ --- ## hugo list expired List all posts already expired ### Synopsis List all of the posts in your content directory which has already expired. ``` hugo list expired ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -s, --source string filesystem path to read files relative from -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_list_future.md000066400000000000000000000015151303124201100226440ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo list future" slug: hugo_list_future url: /commands/hugo_list_future/ --- ## hugo list future List all posts dated in the future ### Synopsis List all of the posts in your content directory which will be posted in the future. ``` hugo list future ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -s, --source string filesystem path to read files relative from -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo list](/commands/hugo_list/) - Listing out various types of content ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_new.md000066400000000000000000000024241303124201100210700ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo new" slug: hugo_new url: /commands/hugo_new/ --- ## hugo new Create new content for your site ### Synopsis Create a new content file and automatically set the date and title. It will guess which kind of file to create based on the path provided. You can also specify the kind with `-k KIND`. If archetypes are provided in your theme or site, they will be used. ``` hugo new [path] ``` ### Options ``` --editor string edit new content with this editor, if provided -f, --format string frontmatter format (default "toml") -k, --kind string Content type to create -s, --source string filesystem path to read files relative from ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site * [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) * [hugo new theme](/commands/hugo_new_theme/) - Create a new theme ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_new_site.md000066400000000000000000000020441303124201100221120ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo new site" slug: hugo_new_site url: /commands/hugo_new_site/ --- ## hugo new site Create a new site (skeleton) ### Synopsis Create a new site in the provided directory. The new site will have the correct structure, but no content or theme yet. Use `hugo new [contentPath]` to create new content. ``` hugo new site [path] ``` ### Options ``` --force Init inside non-empty directory -f, --format string config & frontmatter format (default "toml") ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -s, --source string filesystem path to read files relative from -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_new_theme.md000066400000000000000000000017121303124201100222510ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo new theme" slug: hugo_new_theme url: /commands/hugo_new_theme/ --- ## hugo new theme Create a new theme ### Synopsis Create a new theme (skeleton) called [name] in the current directory. New theme is a skeleton. Please add content to the touched files. Add your name to the copyright line in the license and adjust the theme.toml file as you see fit. ``` hugo new theme [name] ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -s, --source string filesystem path to read files relative from -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo new](/commands/hugo_new/) - Create new content for your site ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_server.md000066400000000000000000000075471303124201100216200ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo server" slug: hugo_server url: /commands/hugo_server/ --- ## hugo server A high performance webserver ### Synopsis Hugo provides its own webserver which builds and serves the site. While hugo server is high performance, it is a webserver with limited options. Many run it in production, but the standard behavior is for people to use it in development and use a more full featured server such as Nginx or Caddy. 'hugo server' will avoid writing the rendered and served content to disk, preferring to store it in memory. By default hugo will also watch your files for any changes you make and automatically rebuild the site. It will then live reload any open browser pages and push the latest content to them. As most Hugo sites are built in a fraction of a second, you will be able to save and see your changes nearly instantly. ``` hugo server ``` ### Options ``` --appendPort append port to baseurl (default true) -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ --bind string interface to which the server will bind (default "127.0.0.1") -D, --buildDrafts include content marked as draft -E, --buildExpired include expired content -F, --buildFuture include content with publishdate in the future --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL --cleanDestinationDir Remove files from destination not found in static directories -c, --contentDir string filesystem path to content directory -d, --destination string filesystem path to write files to --disable404 Do not render 404 page --disableLiveReload watch without enabling live browser reload on rebuild --disableRSS Do not build RSS files --disableSitemap Do not build Sitemap file --forceSyncStatic Copy all files when static is changed. --i18n-warnings Print missing translations --ignoreCache Ignores the cache directory -l, --layoutDir string filesystem path to layout directory --meminterval string interval to poll memory usage (requires --memstats), valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". (default "100ms") --memstats string log memory usage to this file --noChmod Don't sync permission mode of files --noTimes Don't sync modification time of files --pluralizeListTitles Pluralize titles in lists using inflect (default true) -p, --port int port on which the server will listen (default 1313) --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --renderToDisk render to Destination path (default is render to memory & serve from there) -s, --source string filesystem path to read files relative from --stepAnalysis display memory and timing of different steps of the program -t, --theme string theme to use (located in /themes/THEMENAME/) --uglyURLs if true, use /filename.html instead of /filename/ -w, --watch watch filesystem for changes and recreate as needed (default true) ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_undraft.md000066400000000000000000000015461303124201100217460ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo undraft" slug: hugo_undraft url: /commands/hugo_undraft/ --- ## hugo undraft Undraft changes the content's draft status from 'True' to 'False' ### Synopsis Undraft changes the content's draft status from 'True' to 'False' and updates the date to the current date and time. If the content's draft status is 'False', nothing is done. ``` hugo undraft path/to/content ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/commands/hugo_version.md000066400000000000000000000012601303124201100217610ustar00rootroot00000000000000--- date: 2016-10-05T10:21:48+02:00 title: "hugo version" slug: hugo_version url: /commands/hugo_version/ --- ## hugo version Print the version number of Hugo ### Synopsis All software has versions. This is Hugo's. ``` hugo version ``` ### Options inherited from parent commands ``` --config string config file (default is path/config.yaml|json|toml) --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) -v, --verbose verbose output --verboseLog verbose logging ``` ### SEE ALSO * [hugo](/commands/hugo/) - hugo builds your site ###### Auto generated by spf13/cobra on 5-Oct-2016 hugo-0.18.1/docs/content/community/000077500000000000000000000000001303124201100171545ustar00rootroot00000000000000hugo-0.18.1/docs/content/community/contributing.md000066400000000000000000000101751303124201100222110ustar00rootroot00000000000000--- aliases: - /doc/contributing/ - /meta/contributing/ lastmod: 2015-02-12 date: 2013-07-01 menu: main: parent: community next: /tutorials/automated-deployments prev: /community/mailing-list title: Contributing to Hugo weight: 30 --- All contributions to Hugo are welcome. Whether you want to scratch an itch or simply contribute to the project, feel free to pick something from the [roadmap]({{< relref "meta/roadmap.md" >}}) or contact [spf13](http://spf13.com/) about what may make sense to do next. You should 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](https://travis-ci.org/spf13/hugo) 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. ## Contribution Overview We wrote a [detailed guide]({{< relref "tutorials/how-to-contribute-to-hugo.md" >}}) for newcomers that guides you step by step to your first contribution. If you are more experienced, follow the guide below. # Building from source ## 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` ## Running Hugo cd /path/to/hugo go install github.com/spf13/hugo/hugo go run main.go ## Building Hugo cd /path/to/hugo go build -o hugo main.go mv hugo /usr/local/bin/ # Showcase additions You got your new website running and it's powered by Hugo? Great. You can add your website with a few steps to the [showcase](/showcase/). First, make sure that you created a [fork](https://help.github.com/articles/fork-a-repo/) of Hugo on Github and cloned your fork on your local computer. Next, create a separate branch for your additions: ``` # You can choose a different descriptive branch name if you like git checkout -b showcase-addition ``` Let's create a new document that contains some metadata of your homepage. Replace `example` in the following examples with something unique like the name of your website. Inside the terminal enter the following commands: ``` cd docs hugo new showcase/example.md ``` You should find the new file at `content/showcase/example.md`. Open it in an editor. The file should contain a frontmatter with predefined variables like below: ``` --- date: 2016-02-12T21:01:18+01:00 description: "" license: "" licenseLink: "" sitelink: http://spf13.com/ sourceLink: https://github.com/spf13/spf13.com tags: - personal - blog thumbnail: /img/spf13-tn.jpg title: example --- ``` Add at least values for `sitelink`, `title`, `description` and a path for `thumbnail`. Furthermore, we need to create the thumbnail of your website. **It's important that the thumbnail has the required dimensions of 600px by 400px.** Give your thumbnail a name like `example-tn.png`. Save it under `docs/static/img/`. Check a last time that everything works as expected. Start Hugo's built-in server in order to inspect your local copy of the showcase in the browser: hugo server If everything looks fine, we are ready to commit your additions. For the sake of best practices, please make sure that your commit follows our [code contribution guideline](https://github.com/spf13/hugo#code-contribution-guideline). git commit -m"docs: Add example.com to the showcase" Last but not least, we're ready to create a [pull request](https://github.com/spf13/hugo/compare). Don't forget to accept the contributor license agreement. Click on the yellow badge in the automatically added comment in the pull request. hugo-0.18.1/docs/content/community/mailing-list.md000066400000000000000000000020551303124201100220710ustar00rootroot00000000000000--- lastmod: 2015-05-25 date: 2013-07-01 menu: main: parent: community next: /community/contributing prev: /extras/urls title: Mailing List weight: 10 --- ## Discussion Forum Hugo has its own [discussion forum](http://discuss.gohugo.io/) powered by [Discourse](http://www.discourse.org/). Please use this for all discussions, questions, etc. ## Mailing List Hugo has two mailing lists: ### Announcements Very low traffic. Only releases will be emailed here. https://groups.google.com/forum/#!forum/hugo-announce ### Discussion (Archive) **This has been replaced with the [Hugo discussion forum](http://discuss.gohugo.io/).** It is available for archival purposes. https://groups.google.com/forum/#!forum/hugo-discuss ## Other Resources ### GoNuts For general Go questions or discussion please refer to the Go mailing list. https://groups.google.com/forum/#!forum/golang-nuts ### GitHub Issues https://github.com/spf13/hugo/issues ### Twitter Hugo doesn't have its own Twitter handle, but feel free to tweet [@spf13](http://twitter.com/spf13). hugo-0.18.1/docs/content/community/press.md000066400000000000000000000732751303124201100206500ustar00rootroot00000000000000--- lastmod: 2016-10-10 date: 2014-03-24T20:00:00Z linktitle: Press notoc: true title: Press, Blogs and Media Coverage weight: 20 --- ### Help keep this list up to date Know of a post, article or tutorial on Hugo? [Add it to this list](https://github.com/spf13/hugo/edit/master/docs/content/community/press.md). ## Press and Articles Hugo has been featured in the following Blog Posts, Press and Media. | Title | Author | Date | | ------ | ------ | -----: | | [How To Dynamically Use Google Fonts In A Hugo Website](https://stoned.io/web-development/hugo/How-To-Dynamically-Use-Google-Fonts-In-A-Hugo-Website/) | Hash Borgir | 27 Oct 2016 | | [Embedding Facebook In A Hugo Template](https://stoned.io/web-development/hugo/Embedding-Facebook-In-A-Hugo-Template/) | Hash Borgir | 22 Oct 2016 | | [通过 Gitlab-cl 将 Hugo blog 自动部署至 GitHub](https://zetaoyang.github.io/post/2016/10/17/gitlab-cl.html) (Chinese, Continious integration) |Zetao Yang | 17 Oct 2016 | | [A Step-by-Step Guide: Hugo on Netlify](https://www.netlify.com/blog/2016/09/21/a-step-by-step-guide-hugo-on-netlify/) | Eli Williamson | 21 Sep 2016 | | [Building our site: From Django & Wordpress to a static generator (Part I)](https://tryolabs.com/blog/2016/09/20/building-our-site-django-wordpress-to-static-part-i/) | Alan Descoins | 20 Sep 2016 | | [Webseitenmaschine - Statische Websites mit Hugo erzeugen](http://www.heise.de/ct/ausgabe/2016-12-Statische-Websites-mit-Hugo-erzeugen-3211704.html) (German, $) | Christian Helmbold | 27 May 2016 | | [Cómo hacer sitios web estáticos con Hugo y Go - Platzi](https://www.youtube.com/watch?v=qaXXpdiCHXE) (Video tutorial) | Verónica López | 6 Apr 2016 | | [CDNOverview: A CDN comparison site made with Hugo](https://www.cloakfusion.com/cdnoverview-cdn-comparison-site-made-hugo/) | Thijs de Zoete | 23 Feb 2016 | | [Hugo: A Modern WebSite Engine That Just Works](https://github.com/shekhargulati/52-technologies-in-2016/blob/master/07-hugo/README.md) | Shekhar Gulati | 14 Feb 2016 | | [Minify Hugo Generated HTML](http://ratson.name/blog/minify-hugo-generated-html/) | Ratson | 2 Feb 2016 | | [Static site generators: el futuro de las webs estáticas
(Hugo, Jekyll, Flask y otros)](http://sitelabs.es/static-site-generators-futuro-las-webs-estaticas/) | Eneko Sarasola | 9 Jan 2016 | | [Writing a Lambda Function for Hugo](https://blog.jolexa.net/post/writing-a-lambda-function-for-hugo/) | Jeremy Olexa | 1 Jan 2016 | | [Ein Blog mit Hugo erstellen - Tutorial](http://privat.albicker.org/blog/tags/hugo/) (Deutsch/German) | Bernhard Albicker | 30 Dec 2015 | | [How to host Hugo static website generator on AWS Lambda](http://bezdelev.com/post/hugo-aws-lambda-static-website/) | Ilya Bezdelev | 15 Dec 2015 | | [Migrating from Pelican to Hugo](http://www.softinio.com/post/migrating-from-pelican-to-hugo/) | Salar Rahmanian | 29 Nov 2015 | | [Hugo + Uberspace + Git = Hubergit — eine Anleitung (German)](https://harms-ensink.name/post/hubergit/) | Christoph Harms-Ensink | 24 Nov 2015 | | [Static Website Generators Reviewed: Jekyll, Middleman, Roots, Hugo](http://www.smashingmagazine.com/2015/11/static-website-generators-jekyll-middleman-roots-hugo-review/) |
Mathias Biilmann Christensen
| 16 Nov 2015 | | [How To Deploy a Hugo Site to Production with Git Hooks on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-deploy-a-hugo-site-to-production-with-git-hooks-on-ubuntu-14-04) | Justin Ellingwood | 12 Nov 2015 | | [How To Install and Use Hugo, a Static Site Generator, on Ubuntu 14.04](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-hugo-a-static-site-generator-on-ubuntu-14-04) | Justin Ellingwood | 9 Nov 2015 | | [Switching from Wordpress to Hugo](http://justinfx.com/2015/11/08/switching-from-wordpress-to-hugo/) | Justin Israel | 8 Nov 2015 | | [Hands-on Experience with Hugo as a Static Site Generator](http://usersnap.com/blog/hands-on-experience-with-hugo-static-site-generator/) | Thomas Peham | 15 Oct 2015 | | [Statische Webseites mit Hugo erstellen/Vortrag mit Foliensatz (deutsch)](http://sfd.koelnerlinuxtreffen.de/2015/HaraldWeidner/) | Harald Weidner | 19 Sep 2015 | | [Moving from WordPress to Hugo](http://abhipandey.com/2015/09/moving-to-hugo/) | Abhishek Pandey | 15 Sep 2015 | | [通过webhook将Hugo自动部署至GitHub Pages和GitCafe Pages (Automated deployment)](http://blog.coderzh.com/2015/09/13/use-webhook-automated-deploy-hugo/) | CoderZh | 13 Sep 2015 | | [使用hugo搭建个人博客站点 (Using Hugo to build a personal blog site)](http://blog.coderzh.com/2015/08/29/hugo/) | CoderZh | 29 Aug 2015 | | [Good-Bye Wordpress, Hello Hugo!](http://blog.arminhanisch.de/2015/08/blog-migration-zu-hugo/) (German) | Armin Hanisch | 18 Aug 2015 | | [Static Site E-Commerce: Integrating Snipcart with Hugo](https://snipcart.com/blog/snipcart-hugo-integration) | Francis Tremblay | 13 Aug 2015 | | [Générer votre site web statique avec Hugo (Generate your static site with Hugo)](http://www.linux-pratique.com/?p=191) | Benoît Benedetti | 26 June 2015 | | [Hugo向けの新しいテーマを作った (I created a new theme for Hugo)](http://yet.unresolved.xyz/blog/2015/06/20/making-new-theme-robust-for-hugo/) | Daisuke Tsuji | 20 June 2015 | | [Hugo - Gerando um site com conteúdo estático. (Portuguese Brazil)](http://blog.ffrizzo.com/posts/hugo/) | Fabiano Frizzo | 2 Jun 2015 | | [An Introduction to Static Site Generators](http://davidwalsh.name/introduction-static-site-generators) | Eduardo Bouças | 20 May 2015 | | [Hugo Still Rules](http://cheekycoder.com/2015/05/hugo-still-rules/) | Cheeky Coder | 18 May 2015 | | [hugo - Static Site Generator](http://gscacco.github.io/post/hugo/) | G Scaccoio | 4 May 2015 | | [WindowsでHugoを使う](http://ureta.net/2015/05/hugo-on-windows/) | うれ太郎 | 1 May 2015 | | [Hugoのshortcodesを用いてサイトにスライドなどを埋め込む](http://blog.yucchiy.com/2015/04/29/hugo-shortcode/) | Yucchiy | 29 Apr 2015 | | [HugoとCircleCIでGitHub PagesにBlogを公開してみたら超簡単だった](http://hori-ryota.github.io/blog/create-blog-with-hugo-and-circleci/) | Hori Ryota | 17 Apr 2015 | | [How to build a mobile friendly website Part 2 - Ok to Go](http://jbrodriguez.io/mobile-friendly-website-2/) | Juan B. Rodriguez | 13 Apr 2015 | | [10 Best Static Site Generators](http://beebom.com/2015/04/best-static-site-generators) | Aniruddha Mysore | 6 Apr 2015 | | [Goodbye WordPress; Hello Hugo](http://willwarren.com/2015/04/05/goodbye-wordpress-hello-hugo/) | Will Warren | 5 Apr 2015 | | [Static Websites with Hugo on Google Cloud Storage](http://www.moxie.io/post/static-websites-with-hugo-on-google-cloud-storage/) | Moxie Input/Output | 2 Apr 2015 | | [De nuevo iniciando un blog](http://alvarolizama.net/blog/denuevo-iniciando-un-blog/) | Alvaro Lizama | 29 Mar 2015 | | [We moved our blog from Posthaven to Hugo after only three posts. Why?](http://blog.hypriot.com/post/moved-from-posthaven-to-hugo/) | Hypriot | 27 Mar 2015 | | [Hugo is cool](http://tnt.wicast.tk/2015/03/23/hugo-is-cool/) (中文 Chinese) | wicast | 23 Mar 2015 | | [Top Static Site Generators in 2015](http://superdevresources.com/static-site-generators-2015/) | Kanishk Kunal | 12 Mar 2015 | | [Moving to Hugo](http://abiosoft.com/moving-to-hugo/) | Abiola Ibrahim | 8 Mar 2015 | | [Hugoで試行錯誤する - log](http://deprode.net/log/logs/first/) | Deprode | 28 Feb 2015 | | [Migrating a blog (yes, this one!) from Wordpress to Hugo](http://justindunham.net/migrating-from-wordpress-to-hugo/) | Justin Dunham | 13 Feb 2015 | | [blogをoctopressからHugoに乗り換えたメモ](http://blog.jigyakkuma.org/2015/02/11/hugo/) | jigyakkuma | 11 Feb 2015 | | [Hugoでブログをつくった](http://porgy13.github.io/post/new-hugo-blog/) | porgy13 | 7 Feb 2015 | | [Hugoにブログを移行した](http://keichi.net/post/first/) | Keichi Takahashi | 4 Feb 2015 | | [Hugo静态网站生成器中文教程](http://nanshu.wang/post/2015-01-31/) | Nanshu Wang | 31 Jan 2015 | | [Hugo + Github Pages + Wercker CI = ¥0（無料）
でコマンド 1 発（自動化）でサイト
・ブログを公開・運営・分析・収益化](http://qiita.com/yoheimuta/items/8a619cac356bed89a4c9) | Yohei Yoshimuta | 31 Jan 2015 | | [Running Hugo websites on anynines](http://blog.anynines.com/running-hugo-websites-on-anynines/) | Julian Weber | 30 Jan 2015 | | [MiddlemanからHugoへ移行した](http://re-dzine.net/2015/01/hugo/) | Haruki Konishi | 21 Jan 2015 | | [WordPress から Hugo に乗り換えました](http://rakuishi.com/archives/wordpress-to-hugo/) | rakuishi | 20 Jan 2015 | | [HUGOを使ってサイトを立ち上げる方法](http://qiita.com/syui/items/869538099551f24acbbf) | Syui | 17 Jan 2015 | | [Jekyllが許されるのは小学生までだよね](http://t32k.me/mol/log/hugo/) | Ishimoto Koji | 16 Jan 2015 | | [Getting started with Hugo](http://anthonyfok.org/post/getting-started-with-hugo/) | Anthony Fok | 12 Jan 2015 | | [把这个博客静态化了 (Migrate to Hugo)](http://lich-eng.com/2015/01/03/migrate-to-hugo/) | Li Cheng | 3 Jan 2015 | | [My Hugo Experiment](http://tilde.club/~jbaty/2014/12/2014-12-31-my-hugo-experiment/) | Jack Baty | 31 Dec 2014 | | [Porting my blog with Hugo](http://blog.srackham.com/posts/porting-my-blog-with-hugo/) | Stuart Rackham | 30 Dec 2014 | | [Hugoを使ってみたときのメモ](http://machortz.github.io/posts/usinghugo/) | Machortz | 29 Dec 2014 | | [OctopressからHugoへ移行した](http://deeeet.com/writing/2014/12/25/hugo/) | Taichi Nakashima | 25 Dec 2014 | | [Hugo로 Github에 블로그 호스팅하기](http://cdpython.github.io/post/go/hugo/hugo-github/) | CD Python | 25 Dec 2014 | | [Migrating to Hugo From Octopress](http://nathanleclaire.com/blog/2014/12/22/migrating-to-hugo-from-octopress/) | Nathan LeClaire | 22 Dec 2014 | | [Dynamic Pages with GoHugo.io](http://cyrillschumacher.com/2014/12/21/dynamic-pages-with-gohugo.io/) | Cyrill Schumacher | 21 Dec 2014 | | [6 Static Blog Generators That Aren’t Jekyll](http://www.sitepoint.com/6-static-blog-generators-arent-jekyll/) | David Turnbull | 8 Dec 2014 | | [Travel Blogging Setup](http://www.stou.dk/2014/11/travel-blogging-setup/) | Rasmus Stougaard | 23 Nov 2014 | | [Hosting A Hugo Website Behind Nginx](http://www.bigbeeconsultants.co.uk/blog/hosting-hugo-website-behind-nginx) | Rick Beton | 20 Nov 2014 | | [使用Hugo搭建免费个人Blog (How to use Hugo)](http://ulricqin.com/post/how-to-use-hugo/) | Ulric Qin 秦晓辉 | 11 Nov 2014 | | [Built in Speed and Built for Speed by Hugo](http://cheekycoder.com/2014/10/built-for-speed-by-hugo/) | Cheeky Coder | 30 Oct 2014 | | [hugo, syncthing](http://fredix.ovh/2014/10/hugo-syncthing/) | Frédéric Logier | 13 Oct 2014 | | [Hugo para crear sitios web estáticos](http://www.webbizarro.com/noticias/1076/hugo-para-crear-sitios-web-estaticos/) | Web Bizarro | 19 Aug 2014 | | [Going with hugo](http://www.markuseliasson.se/article/going-with-hugo/) | Markus Eliasson | 18 Aug 2014 | | [Benchmarking Jekyll, Hugo and Wintersmith](http://fredrikloch.me/post/2014-08-12-Jekyll-and-its-alternatives-from-a-site-generation-point-of-view/) | Fredrik Loch | 12 Aug 2014 | | [Goodbye Octopress, Hello Hugo!](http://andreimihu.com/blog/2014/08/11/goodbye-octopress-hello-hugo/) | Andrei Mihu | 11 Aug 2014 | | [Beautiful sites for Open Source projects](http://beautifulopen.com/2014/08/09/hugo/) | Beautiful Open | 9 Aug 2014 | | [Hugo: Beyond the Defaults](http://npf.io/2014/08/hugo-beyond-the-defaults/) | Nate Finch | 8 Aug 2014 | | [First Impressions of Hugo](https://peteraba.com/blog/first-impressions-of-hugo/) | Peter Aba | 6 Aug 2014 | | [New Site Workflow](http://vurt.co.uk/post/new_website/) | Giles Paterson | 5 Aug 2014 | | [How I Learned to Stop Worrying and Love the (Static) Web](http://cognition.ca/post/about-hugo/) | Joshua McKenty | 4 Aug 2014 | | [Hugo - Static Site Generator](http://kenwoo.io/blog/hugo---static-site-generator/) | Kenny Woo | 3 Aug 2014 | | [Hugo Is Friggin' Awesome](http://npf.io/2014/08/hugo-is-awesome/) | Nate Finch | 1 Aug 2014 | | [再次搬家 (Move from WordPress to Hugo)](http://www.chingli.com/misc/move-from-wordpress-to-hugo/) | 青砾 (chingli) | 12 July 2014 | | [Embedding Gists in Hugo](http://danmux.com/posts/embedded_gists/) | Dan Mull | 5 July 2014 | | [An Introduction To Hugo](http://www.cirrushosting.com/web-hosting-blog/an-introduction-to-hugo/) | Dan Silber | 1 July 2014 | | [Moving to Hugo](http://danmux.com/posts/hugo_based_blog/) | Dan Mull | 29 May 2014 | | [开源之静态站点生成器排行榜
(Leaderboard of open-source static website generators)](http://code.csdn.net/news/2819909) | CSDN.net | 23 May 2014 | | [How I deploy this site using Fabric](http://carlorat.me/quote/fabric/) | Carlo Ratam | 21 May 2014 | | [Finally, a satisfying and effective blog setup](http://michaelwhatcott.com/now-powered-by-hugo/) | Michael Whatcott | 20 May 2014 | | [Hugo from scratch](http://zackofalltrades.com/notes/2014/05/hugo-from-scratch/) | Zack Williams | 18 May 2014 | | [Why I switched away from Jekyll](http://www.jakejanuzelli.com/why-I-switched-away-from-jekyll/) | Jake Januzelli | 10 May 2014 | | [Welcome our new blog](http://blog.ninya.io/posts/welcome-our-new-blog/) | Ninya.io | 11 Apr 2014 | | [Mission Not Accomplished](http://johnsto.co.uk/blog/mission-not-accomplished/) | Dave Johnston | 3 Apr 2014 | | [Hugo - A Static Site Builder in Go](http://deepfriedcode.com/post/hugo/) | Deep Fried Code | 30 Mar 2014 | | [Adventures in Angular Podcast](http://devchat.tv/adventures-in-angular/003-aia-gdes) | Matias Niemela | 28 Mar 2014 | | [Hugo](http://bra.am/post/hugo/) | bra.am | 23 Mar 2014 | | [Converting Blogger To Markdown](http://trishagee.github.io/project/atom-to-hugo/) | Trisha Gee | 20 Mar 2014 | | [Moving to Hugo Static Web Pages](http://tepid.org/tech/hugo-web/) | Tobias Weingartner | 16 Mar 2014 | | [Hugo and GitHub Pages](http://spencerlyon.com/blog/2014/creating-the-site/) | Spencer Lyon | 15 Mar 2014 | | [New Blog Engine: Hugo](https://blog.afoolishmanifesto.com/posts/hugo/) | fREW Schmidt | 15 Mar 2014 | | [Hugo + gulp.js = Huggle](http://ktmud.github.io/huggle/en/intro/) ([English](http://ktmud.github.io/huggle/en/intro/), [中文](http://ktmud.github.io/huggle/zh/intro/)) | Jesse Yang 杨建超 | 8 Mar 2014 | | [Powered by Hugo](http://kieranhealy.org/blog/archives/2014/02/24/powered-by-hugo/) | Kieran Healy | 24 Feb 2014 | | [静的サイトを素早く構築するために
GoLangで作られたジェネレータHugo](http://hamasyou.com/blog/2014/02/21/hugo/) |
Shogo Hamada
濱田章吾
| 21 Feb 2014 | | [Latest Roundup of Useful Tools For Developers](http://codegeekz.com/latest-roundup-of-useful-tools-for-developers/) | CodeGeekz | 13 Feb 2014 | | [Hugo: Static Site Generator written in Go](http://www.braveterry.com/2014/02/06/hugo-static-site-generator-written-in-go/) | Brave Terry | 6 Feb 2014 | | [10 Useful HTML5 Tools for Web Designers and Developers](http://designdizzy.com/10-useful-html5-tools-for-web-designers-and-developers/) | Design Dizzy | 4 Feb 2014 | | [Hugo – Fast, Flexible Static Site Generator](http://cube3x.com/hugo-fast-flexible-static-site-generator/) | Joby Joseph | 18 Jan 2014 | | [Hugo: A new way to build static website](http://www.w3update.com/opensource/hugo-a-new-way-to-build-static-website.html) | w3update | 17 Jan 2014 | | [Xaprb now uses Hugo](http://xaprb.com/blog/2014/01/15/using-hugo/) | Baron Schwartz | 15 Jan 2014 | | [New jQuery Plugins And Resources That Web Designers Need](http://www.designyourway.net/blog/resources/new-jquery-plugins-and-resources-that-web-designers-need/) | Design Your Way | 2014 | | [On Blog Construction](http://alexla.sh/post/on-blog-construction/) | Alexander Lash | 27 Dec 2013 | | [Hugo](http://onethingwell.org/post/69070926608/hugo) | One Thing Well | 5 Dec 2013 | | [In Praise Of Hugo](http://sound-guru.com/blog/post/hello-world/) | sound-guru.com | 19 Oct 2013 | | [Hosting a blog on S3 and Cloudfront](http://www.danesparza.net/2013/07/hosting-a-blog-on-s3-and-cloudfront/) | Dan Esparza | 24 July 2013 | hugo-0.18.1/docs/content/content/000077500000000000000000000000001303124201100166025ustar00rootroot00000000000000hugo-0.18.1/docs/content/content/archetypes.md000066400000000000000000000123071303124201100212760ustar00rootroot00000000000000--- lastmod: 2016-10-01 date: 2014-05-14T02:13:50Z menu: main: parent: content next: /content/ordering prev: /content/types title: Archetypes weight: 50 toc: true --- In Hugo v0.11, we introduced the concept of a content builder. Using the CLI command hugo new [path/to/my/content], an author could create an empty content file, with the date and title automatically defined in the front matter of the post. While this was a welcome feature, active writers need more flexibility. When defining a custom content type, you can use an **archetype** as a way to define the default metadata for a new post of that type. **Archetypes** are quite literally archetypal content files with pre-configured [front matter](/content/front-matter). An archetype will populate each new content file of a given type with any default metadata you've defined whenever you run the `hugo new` command. ## Example ### Step 1. Creating an archetype In the following example scenario, suppose we have a blog with a single content type (blog post). Our imaginary blog will use ‘tags’ and ‘categories’ for its taxonomies, so let's create an archetype file with ‘tags’ and ‘categories’ pre-defined: #### archetypes/default.md ```toml +++ tags = ["x", "y"] categories = ["x", "y"] +++ ``` > __CAVEAT:__ Some editors (e.g. Sublime, Emacs) do not insert an EOL (end-of-line) character at the end of the file (i.e. EOF). If you get a [strange EOF error](/troubleshooting/strange-eof-error/) when using `hugo new`, please open each archetype file (i.e. `archetypes/*.md`) and press Enter to type a carriage return after the closing `+++` or `---` as necessary. ### Step 2. Using the archetype Now, with `archetypes/default.md` in place, let's create a new post in the `post` section with the `hugo new` command: $ hugo new post/my-new-post.md Hugo will now create the file with the following contents: #### content/post/my-new-post.md ```toml +++ title = "my new post" date = "2015-01-12T19:20:04-07:00" tags = ["x", "y"] categories = ["x", "y"] +++ ``` We see that the `title` and `date` variables have been added, in addition to the `tags` and `categories` variables which were carried over from `archetype/default.md`. Congratulations! We have successfully created an archetype and used it to quickly scaffold out a new post. But wait, what if we want to create some content that isn't exactly a blog post, like a profile for a musician? Let's see how using **archetypes** can help us out. ### Creating custom archetypes Previously, we had created a new content type by adding a new subfolder to the content directory. In this case, its name would be `content/musician`. To begin using a `musician` archetype for each new `musician` post, we simply need to create a file named after the content type called `musician.md`, and put it in the `archetypes` directory, similar to the one below. #### archetypes/musician.md ```toml +++ name = "" bio = "" genre = "" +++ ``` Now, let's create a new musician. $ hugo new musician/mozart.md This time, Hugo recognizes our custom `musician` archetype and uses it instead of the default one. Take a look at the new `musician/mozart.md` post. You should see that the generated file's front matter now includes the variables `name`, `bio`, and `genre`. #### content/musician/mozart.md ```toml +++ title = "mozart" date = "2015-08-24T13:04:37+02:00" name = "" bio = "" genre = "" +++ ``` ## Using a different front matter format By default, the front matter will be created in the TOML format regardless of what format the archetype is using. You can specify a different default format in your site-wide config file (e.g. `config.toml`) using the `MetaDataFormat` directive. Possible values are `"toml"`, `"yaml"` and `"json"`. ## Which archetype is being used The following rules apply when creating new content: * If an archetype with a filename matching the new post's [content type](/content/types) exists, it will be used. * If no match is found, `archetypes/default.md` will be used. * If neither is present and a theme is in use, then within the theme: * If an archetype with a filename that matches the content type being created, it will be used. * If no match is found, `archetypes/default.md` will be used. * If no archetype files are present, then the one that ships with Hugo will be used. Hugo provides a simple archetype which sets the `title` (based on the file name) and the `date` in RFC 3339 format based on [`now()`](http://golang.org/pkg/time/#Now), which returns the current time. > *Note: `hugo new` does not automatically add `draft = true` when the user > provides an archetype. This is by design, rationale being that > the archetype should set its own value for all fields. > `title` and `date`, which are dynamic and unique for each piece of content, > are the sole exceptions.* The content type is automatically detected based on the file path passed to the Hugo CLI command hugo new [my-content-type/post-name]. To override the content type for a new post, include the `--kind` flag during creation. > *Note: if you wish to use archetypes that ship with a theme, the theme MUST be specified in your `config.toml`.* hugo-0.18.1/docs/content/content/example.md000066400000000000000000000050501303124201100205570ustar00rootroot00000000000000--- aliases: - /doc/example/ lastmod: 2015-12-23 date: 2013-07-01 linktitle: Example menu: main: parent: content prev: /content/multilingual next: /themes/overview notoc: true title: Example Content File weight: 70 --- Some things are better shown than explained. The following is a very basic example of a content file written in [Markdown](https://help.github.com/articles/github-flavored-markdown/): **mysite/content/project/nitro.md → http://mysite.com/project/nitro.html** With TOML front matter: 
+++
date        = "2013-06-21T11:27:27-04:00"
title       = "Nitro: A quick and simple profiler for Go"
description = "Nitro is a simple profiler for your Golang applications"
tags        = [ "Development", "Go", "profiling" ]
topics      = [ "Development", "Go" ]
slug        = "nitro"
project_url = "https://github.com/spf13/nitro"
+++
# Nitro

Quick and easy performance analyzer library for [Go](http://golang.org/).

## Overview

Nitro is a quick and easy performance analyzer library for Go.
It is useful for comparing A/B against different drafts of functions
or different functions.

## Implementing Nitro

Using Nitro is simple. First, use `go get` to install the latest version
of the library.

    $ go get github.com/spf13/nitro

Next, include nitro in your application.
You may also use the equivalent YAML front matter: ```yaml --- lastmod: 2015-12-23 date: "2013-06-21T11:27:27-04:00" title: "Nitro: A quick and simple profiler for Go" description: "Nitro is a simple profiler for your Go lang applications" tags: [ "Development", "Go", "profiling" ] topics: [ "Development", "Go" ] slug: "nitro" project_url: "https://github.com/spf13/nitro" --- ``` `nitro.md` would be rendered as follows: > # Nitro > > Quick and easy performance analyzer library for [Go](http://golang.org/). > > ## Overview > > Nitro is a quick and easy performance analyzer library for Go. > It is useful for comparing A/B against different drafts of functions > or different functions. > > ## Implementing Nitro > > Using Nitro is simple. First, use `go get` to install the latest version > of the library. > > $ go get github.com/spf13/nitro > > Next, include nitro in your application. The source `nitro.md` file is converted to HTML by the excellent [Blackfriday](https://github.com/russross/blackfriday) Markdown processor, which supports extended features found in the popular [GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). hugo-0.18.1/docs/content/content/front-matter.md000066400000000000000000000103211303124201100215430ustar00rootroot00000000000000--- aliases: - /doc/front-matter/ lastmod: 2015-12-23 date: 2013-07-01 menu: main: parent: content next: /content/sections prev: /content/organization title: Front Matter weight: 20 toc: true --- The **front matter** is one of the features that gives Hugo its strength. It enables you to include the meta data of the content right with it. Hugo supports a few different formats, each with their own identifying tokens. Supported formats: * **[TOML][]**, identified by '`+++`'. * **[YAML][]**, identified by '`---`'. * **[JSON][]**, a single JSON object which is surrounded by '`{`' and '`}`', each on their own line. [TOML]: https://github.com/toml-lang/toml "Tom's Obvious, Minimal Language" [YAML]: http://www.yaml.org/ "YAML Ain't Markup Language" [JSON]: http://www.json.org/ "JavaScript Object Notation" ## TOML Example 
+++
title = "spf13-vim 3.0 release and new website"
description = "spf13-vim is a cross platform distribution of vim plugins and resources for Vim."
tags = [ ".vimrc", "plugins", "spf13-vim", "vim" ]
date = "2012-04-06"
categories = [
  "Development",
  "VIM"
]
slug = "spf13-vim-3-0-release-and-new-website"
+++
Content of the file goes Here
## YAML Example ```yaml --- title: "spf13-vim 3.0 release and new website" description: "spf13-vim is a cross platform distribution of vim plugins and resources for Vim." tags: [ ".vimrc", "plugins", "spf13-vim", "vim" ] lastmod: 2015-12-23 date: "2012-04-06" categories: - "Development" - "VIM" slug: "spf13-vim-3-0-release-and-new-website" --- Content of the file goes Here ``` ## JSON Example ```json { "title": "spf13-vim 3.0 release and new website", "description": "spf13-vim is a cross platform distribution of vim plugins and resources for Vim.", "tags": [ ".vimrc", "plugins", "spf13-vim", "vim" ], "date": "2012-04-06", "categories": [ "Development", "VIM" ], "slug": "spf13-vim-3-0-release-and-new-website" } Content of the file goes Here ``` ## Variables There are a few predefined variables that Hugo is aware of and utilizes. The user can also create any variable they want. These will be placed into the `.Params` variable available to the templates. Field names are always normalized to lowercase (e.g. `camelCase: true` is available as `.Params.camelcase`). ### Required variables * **title** The title for the content * **description** The description for the content * **date** The date the content will be sorted by * **taxonomies** These will use the field name of the plural form of the index (see tags and categories above) ### Optional variables * **aliases** An array of one or more aliases (e.g. old published path of a renamed content) that would be created to redirect to this content. See [Aliases]({{< relref "extras/aliases.md" >}}) for details. * **draft** If true, the content will not be rendered unless `hugo` is called with `--buildDrafts` * **publishdate** If in the future, content will not be rendered unless `hugo` is called with `--buildFuture` * **expirydate** Content already expired will not be rendered unless `hugo` is called with `--buildExpired` * **type** The type of the content (will be derived from the directory automatically if unset) * **isCJKLanguage** If true, explicitly treat the content as CJKLanguage (`.Summary` and `.WordCount` can work properly in CJKLanguage) * **weight** Used for sorting * **markup** *(Experimental)* Specify `"rst"` for reStructuredText (requires `rst2html`) or `"md"` (default) for Markdown * **slug** appears as tail of the url. It can be used to change the part of the url that is based on the filename. * **url** The full path to the content from the web root. It makes no assumptions about the path of the content file. It also ignores any language prefixes of the multilingual feature. *If neither `slug` or `url` is present, the filename will be used.* ## Configure Blackfriday rendering It's possible to set some options for Markdown rendering in the page's front matter as an override to the site wide configuration. See [Configuration]({{< ref "overview/configuration.md#configure-blackfriday-rendering" >}}) for more. hugo-0.18.1/docs/content/content/markdown-extras.md000066400000000000000000000021121303124201100222460ustar00rootroot00000000000000--- aliases: - /doc/supported-formats/ lastmod: 2016-07-22 date: 2016-07-22 menu: main: parent: content prev: /content/summaries next: /content/multilingual title: Markdown Extras weight: 66 toc: false --- Hugo provides some convenient markdown extensions. ## Task lists Hugo supports GitHub styled task lists (TODO lists) for the Blackfriday renderer (md-files). See [Blackfriday config](/overview/configuration/#configure-blackfriday-rendering) for how to turn it off. Example: ```markdown - [ ] a task list item - [ ] list syntax required - [ ] incomplete - [x] completed ``` Renders as: - [ ] a task list item - [ ] list syntax required - [ ] incomplete - [x] completed And produces this HTML: ```html
  • a task list item
  • list syntax required
  • incomplete
  • completed
``` hugo-0.18.1/docs/content/content/multilingual.md000066400000000000000000000153641303124201100216430ustar00rootroot00000000000000--- date: 2016-01-02T21:21:00Z menu: main: parent: content prev: /content/markdown-extras next: /content/example title: Multilingual Mode weight: 68 toc: true --- Hugo supports multiple languages side-by-side (added in `Hugo 0.17`). Define the available languages in a `Languages` section in your top-level `config.toml` (or equivalent). Example: ``` defaultContentLanguage = "en" Languages: en: weight: 1 title: "My blog" params: linkedin: "english-link" fr: weight: 2 title: "Mon blog" params: linkedin: "lien-francais" copyright: "Tout est à moi" copyright: "Everything is mine" ``` Anything not defined in a `[lang]:` block will fall back to the global value for that key (like `copyright` for the English (`en`) language in this example). With the config above, all content, sitemap, RSS feeds, paginations and taxonomy pages will be rendered below `/` in English (your default content language), and below `/fr` in French. If you want all of the languages to be put below their respective language code, enable `defaultContentLanguageInSubdir: true` in your configuration. Only the obvious non-global options can be overridden per language. Examples of global options are `BaseURL`, `BuildDrafts`, etc. Taxonomies and Blackfriday configuration can also be set per language, example: ``` [Taxonomies] tag = "tags" [blackfriday] angledQuotes = true hrefTargetBlank = true [Languages] [Languages.en] weight = 1 title = "English" [Languages.en.blackfriday] angledQuotes = false [Languages.fr] weight = 2 title = "Français" [Languages.fr.Taxonomies] plaque = "plaques" ``` ### Translating your content Translated articles are identified by the name of the content file. Example of translated articles: 1. `/content/about.en.md` 2. `/content/about.fr.md` You can also have: 1. `/content/about.md` 2. `/content/about.fr.md` In which case the config variable `defaultContentLanguage` will be used to affect the default language `about.md`. This way, you can slowly start to translate your current content without having to rename everything. If left unspecified, the value for `defaultContentLanguage` defaults to `en`. By having the same _base file name_, the content pieces are linked together as translated pieces. ### Link to translated content To create a list of links to translated content, use a template similar to this: ``` {{ if .IsTranslated }}

{{ i18n "translations" }}

{{ end }} ``` The above can be put in a `partial` and included in any template, be it for a content page or the home page. It will not print anything if there are no translations for a given page, or if it is -- in the case of the home page, section listing etc. -- a site with only one language. The above also uses the `i18n` func, see [Translation of strings](#translation-of-strings). ### Translation of strings Hugo uses [go-i18n](https://github.com/nicksnyder/go-i18n) to support string translations. Follow the link to find tools to manage your translation workflows. Translations are collected from the `themes/[name]/i18n/` folder (built into the theme), as well as translations present in `i18n/` at the root of your project. In the `i18n`, the translations will be merged and take precedence over what is in the theme folder. Language files should be named according to RFC 5646 with names such as `en-US.yaml`, `fr.yaml`, etc. From within your templates, use the `i18n` function like this: ``` {{ i18n "home" }} ``` This uses a definition like this one in `i18n/en-US.yaml`: ``` - id: home translation: "Home" ``` Often you will want to use to the page variables in the translations strings. To do that, pass on the "." context when calling `i18n`: ``` {{ i18n "wordCount" . }} ``` This uses a definition like this one in `i18n/en-US.yaml`: ``` - id: wordCount translation: "This article has {{ .WordCount }} words." ``` An example of singular and plural form: ``` - id: readingTime translation: one: "One minute read" other: "{{.Count}} minutes read" ``` And then in the template: ``` {{ i18n "readingTime" .ReadingTime }} ``` To track down missing translation strings, run Hugo with the `--i18n-warnings` flag: ```bash hugo --i18n-warnings | grep i18n i18n|MISSING_TRANSLATION|en|wordCount ``` ### Menus You can define your menus for each language independently. The [creation of a menu]({{< relref "extras/menus.md" >}}) works analogous to earlier versions of Hugo, except that they have to be defined in their language-specific block in the configuration file: ```toml defaultContentLanguage = "en" [languages.en] weight = 0 languageName = "English" [[languages.en.menu.main]] url = "/" name = "Home" weight = 0 [languages.de] weight = 10 languageName = "Deutsch" [[languages.de.menu.main]] url = "/" name = "Startseite" weight = 0 ``` The rendering of the main navigation works as usual. `.Site.Menus` will just contain the menu of the current language. Pay attention to the generation of the menu links. `absLangURL` takes care that you link to the correct locale of your website. Otherwise, both menu entries would link to the English version because it's the default content language that resides in the root directory. ```html
    {{- $currentPage := . -}} {{ range .Site.Menus.main -}}
  • {{ .Name }}
    • {{- end }}
``` ### Missing translations If a string does not have a translation for the current language, Hugo will use the value from the default language. If no default value is set, an empty string will be shown. While translating a Hugo site, it can be handy to have a visual indicator of missing translations. The `EnableMissingTranslationPlaceholders` config option will flag all untranslated strings with the placeholder `[i18n] identifier`, where `identifier` is the id of the missing translation. **Remember: Hugo will generate your website with these placeholders. It might not be suited for production environments.** ### Multilingual Themes support To support Multilingual mode in your themes, some considerations must be taken for the URLs in the templates. If there are more than one language, URLs must either come from the built-in `.Permalink` or `.URL`, be constructed with `relLangURL` or `absLangURL` template funcs -- or prefixed with `{{.LanguagePrefix }}`. If there are more than one language defined, the`LanguagePrefix` variable will equal `"/en"` (or whatever your `CurrentLanguage` is). If not enabled, it will be an empty string, so it is harmless for single-language sites. hugo-0.18.1/docs/content/content/ordering.md000066400000000000000000000020661303124201100207410ustar00rootroot00000000000000--- lastmod: 2015-12-23 date: 2014-03-06 linktitle: Ordering menu: main: parent: content next: /content/summaries prev: /content/archetypes title: Ordering Content weight: 60 --- Hugo provides you with all the flexibility you need to organize how your content is ordered. By default, content is ordered by weight, then by date with the most recent date first, but alternative sorting (by `title` and `linktitle`) is also available. The order the content would appear is specified in the [list template](/templates/list/). _Both the `date` and `weight` fields are optional._ Unweighted pages appear at the end of the list. If no weights are provided (or if weights are the same), `date` will be used to sort. If neither is provided, content will be ordered based on how it's read off the disk, and no order is guaranteed. ## Assigning weight to content ```toml +++ weight = 4 title = "Three" date = "2012-04-06" +++ Front Matter with Ordered Pages 3 ``` ## Ordering Content Within Taxonomies Please see the [Taxonomy Ordering Documentation](/taxonomies/ordering/). hugo-0.18.1/docs/content/content/organization.md000066400000000000000000000126051303124201100216340ustar00rootroot00000000000000--- aliases: - /doc/organization/ lastmod: 2015-09-27 date: 2013-07-01 linktitle: Organization menu: main: parent: content next: /content/supported-formats prev: /overview/source-directory title: Content Organization weight: 10 toc: true --- Hugo uses files (see [supported formats](/content/supported-formats/)) with headers commonly called the *front matter*. Hugo respects the organization that you provide for your content to minimize any extra configuration, though this can be overridden by additional configuration in the front matter. ## Organization In Hugo, the content should be arranged in the same way they are intended for the rendered website. Without any additional configuration, the following will just work. Hugo supports content nested at any level. The top level is special in Hugo and is used as the [section](/content/sections/). . └── content └── about | └── index.md // <- http://1.com/about/ ├── post | ├── firstpost.md // <- http://1.com/post/firstpost/ | ├── happy | | └── ness.md // <- http://1.com/post/happy/ness/ | └── secondpost.md // <- http://1.com/post/secondpost/ └── quote ├── first.md // <- http://1.com/quote/first/ └── second.md // <- http://1.com/quote/second/ **Here's the same organization run with `hugo --uglyURLs`** . └── content └── about | └── index.md // <- http://1.com/about/ ├── post | ├── firstpost.md // <- http://1.com/post/firstpost.html | ├── happy | | └── ness.md // <- http://1.com/post/happy/ness.html | └── secondpost.md // <- http://1.com/post/secondpost.html └── quote ├── first.md // <- http://1.com/quote/first.html └── second.md // <- http://1.com/quote/second.html ## Destinations Hugo believes that you organize your content with a purpose. The same structure that works to organize your source content is used to organize the rendered site. As displayed above, the organization of the source content will be mirrored in the destination. Notice that the first level `about/` page URL was created using a directory named "about" with a single `index.md` file inside. There are times when one would need more control over their content. In these cases, there are a variety of things that can be specified in the front matter to determine the destination of a specific piece of content. The following items are defined in order, latter items in the list will override earlier settings. ### filename This isn't in the front matter, but is the actual name of the file minus the extension. This will be the name of the file in the destination. ### slug Defined in the front matter, the `slug` can take the place of the filename for the destination. ### filepath The actual path to the file on disk. Destination will create the destination with the same path. Includes [section](/content/sections/). ### section `section` is determined by its location on disk and can *not* be specified in the front matter. See [section](/content/sections/). ### type `type` is also determined by its location on disk but, unlike `section`, it *can* be specified in the front matter. See [type](/content/types/). ### path `path` can be provided in the front matter. This will replace the actual path to the file on disk. Destination will create the destination with the same path. Includes [section](/content/sections/). ### url A complete URL can be provided. This will override all the above as it pertains to the end destination. This must be the path from the baseURL (starting with a "/"). When a `url` is provided, it will be used exactly. Using `url` will ignore the `--uglyURLs` setting. ## Path breakdown in Hugo ### Content . path slug . ⊢-------^----⊣ ⊢------^-------⊣ content/extras/indexes/category-example/index.html . section slug . ⊢--^--⊣ ⊢------^-------⊣ content/extras/indexes/category-example/index.html . section slug . ⊢--^--⊣⊢--^--⊣ content/extras/indexes/index.html ### Destination permalink ⊢--------------^-------------⊣ http://spf13.com/projects/hugo baseURL section slug ⊢-----^--------⊣ ⊢--^---⊣ ⊢-^⊣ http://spf13.com/projects/hugo baseURL section slug ⊢-----^--------⊣ ⊢--^--⊣ ⊢--^--⊣ http://spf13.com/extras/indexes/example baseURL path slug ⊢-----^--------⊣ ⊢------^-----⊣ ⊢--^--⊣ http://spf13.com/extras/indexes/example baseURL url ⊢-----^--------⊣ ⊢-----^-----⊣ http://spf13.com/projects/hugo baseURL url ⊢-----^--------⊣ ⊢--------^-----------⊣ http://spf13.com/extras/indexes/example **section** = which type the content is by default * based on content location * front matter overrides **slug** = name.ext or name/ * based on content-name.md * front matter overrides **path** = section + path to file excluding slug * based on path to content location **url** = relative URL * defined in front matter * overrides all the above hugo-0.18.1/docs/content/content/sections.md000066400000000000000000000034171303124201100207600ustar00rootroot00000000000000--- lastmod: 2015-12-23 date: 2013-07-01 menu: main: parent: content next: /content/types notoc: true prev: /content/front-matter title: Sections weight: 30 --- Hugo believes that you organize your content with a purpose. The same structure that works to organize your source content is used to organize the rendered site (see [Organization](/content/organization/)). Following this pattern Hugo uses the top level of your content organization as **the Section**. The following example site uses two sections, "post" and "quote". {{< nohighlight >}}. └── content ├── post | ├── firstpost.md // <- http://1.com/post/firstpost/ | ├── happy | | └── ness.md // <- http://1.com/post/happy/ness/ | └── secondpost.md // <- http://1.com/post/secondpost/ └── quote ├── first.md // <- http://1.com/quote/first/ └── second.md // <- http://1.com/quote/second/ {{< /nohighlight >}} ## Section Lists Hugo will automatically create pages for each section root that list all of the content in that section. See [List Templates](/templates/list/) for details on customizing the way they appear. Section pages can also have a content file and frontmatter, see [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}). ## Sections and Types By default everything created within a section will use the content type that matches the section name. Section defined in the front matter have the same impact. To change the type of a given piece of content, simply define the type in the front matter. If a layout for a given type hasn't been provided, a default type template will be used instead provided it exists. hugo-0.18.1/docs/content/content/summaries.md000066400000000000000000000052531303124201100211360ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2013-07-01 menu: main: parent: content notoc: true prev: /content/ordering next: /content/markdown-extras title: Summaries weight: 65 --- With the use of the `.Summary` [page variable](/templates/variables/), Hugo can generate summaries of content to show snippets in summary views. The summary view snippets are automatically generated by Hugo. Where a piece of content is split for the content summary depends on whether the split is Hugo-defined or user-defined. Content summaries may also provide links to the original content, usually in the form of a "Read More..." link, with the help of the `.RelPermalink` or `.Permalink` variable, as well as the `.Truncated` boolean variable to determine whether such "Read More..." link is necessary. ## Hugo-defined: automatic summary split By default, Hugo automatically takes the first 70 words of your content as its summary and stores it into the `.Summary` variable, which you may use in your templates. * Pros: Automatic, no additional work on your part. * Cons: All HTML tags are stripped from the summary, and the first 70 words, whether they belong to a heading or to different paragraphs, are all lumped into one paragraph. Some people like it, but some people don't. ## User-defined: manual summary split: Alternatively, you may add the <!--more--> summary divider[^1] where you want to split the article. Content prior to the summary divider will be used as that content's summary, and stored into the `.Summary` variable with all HTML formatting intact. [^1]: The **summary divider** is also called "more tag", "excerpt separator", etc. in other literature. * Pros: Freedom, precision, and improved rendering. All formatting is preserved. * Cons: Need to remember to type <!--more--> in your content file. :-) Be careful to enter <!--more--> exactly, i.e. all lowercase with no whitespace, otherwise it would be treated as regular comment and ignored. ## Showing Summaries You can show content summaries with the following code. You could do this, for example, on a [list](/templates/list/) page. {{ range first 10 .Data.Pages }}

{{ .Title }}

{{ .Summary }}
{{ if .Truncated }}
Read More…
{{ end }} {{ end }} Note how the `.Truncated` boolean valuable may be used to hide the "Read More..." link when the content is not truncated, i.e. when the summary contains the entire article. hugo-0.18.1/docs/content/content/supported-formats.md000066400000000000000000000022261303124201100226240ustar00rootroot00000000000000--- aliases: - /doc/supported-formats/ lastmod: 2015-08-01 date: 2015-08-01 menu: main: parent: content next: /content/front-matter prev: /content/organization title: Supported Formats weight: 15 toc: true --- Since 0.14, Hugo has defined a new concept called _external helpers_. It means that you can write your content using Asciidoc[tor], or reStructuredText. If you have files with associated extensions ([details](https://github.com/spf13/hugo/blob/77c60a3440806067109347d04eb5368b65ea0fe8/helpers/general.go#L65)), then Hugo will call external commands to generate the content. This means that you will have to install the associated tool on your machine to be able to use those formats. For example, for Asciidoc files, Hugo will try to call __asciidoctor__ or __asciidoc__ command. To use those formats, just use the standard extension and the front matter exactly as you would do with natively supported _.md_ files. Notes: * as these are external commands, generation performance for that content will heavily depend on the performance of those external tools. * this feature is still in early stage, hence feedback is even more welcome. hugo-0.18.1/docs/content/content/types.md000066400000000000000000000056761303124201100203060ustar00rootroot00000000000000--- lastmod: 2015-09-28 date: 2013-07-01 linktitle: Types menu: main: parent: content next: /content/archetypes prev: /content/sections title: Content Types weight: 40 toc: true --- Hugo has full support for different types of content. A content type can have a unique set of meta data, template and can be automatically created by the `hugo new` command through using content [archetypes](/content/archetypes/). A good example of when multiple types are needed is to look at [Tumblr](https://www.tumblr.com/). A piece of content could be a photo, quote or post, each with different meta data and rendered differently. ## Assigning a content type Hugo assumes that your site will be organized into [sections](/content/sections/) and each section will use the corresponding type. If you are taking advantage of this, then each new piece of content you place into a section will automatically inherit the type. Alternatively, you can set the type in the meta data under the key "`type`". ## Creating new content of a specific type Hugo has the ability to create a new content file and populate the front matter with the data set corresponding to that type. Hugo does this by utilizing [archetypes](/content/archetypes/). To create a new piece of content, use: hugo new relative/path/to/content.md For example, if I wanted to create a new post inside the post section, I would type: hugo new post/my-newest-post.md ## Defining a content type Creating a new content type is easy in Hugo. You simply provide the templates and archetype that the new type will use. You only need to define the templates, archetypes and/or views unique to that content type. Hugo will fall back to using the general templates and default archetype whenever a specific file is not present. *Remember, all of the following are optional:* ### Create Type Directory Create a directory with the name of the type in `/layouts`. Type is always singular. *E.g. `/layouts/post`*. ### Create single template Create a file called `single.html` inside your directory. *E.g. `/layouts/post/single.html`*. ### Create list template Create a file called `post.html` inside the section lists template directory, `/layouts/section`. *E.g. `/layouts/section/post.html`*. ### Create views Many sites support rendering content in a few different ways, for instance, a single page view and a summary view to be used when displaying a [list of contents on a single page](/templates/list). Hugo makes no assumptions here about how you want to display your content, and will support as many different views of a content type as your site requires. All that is required for these additional views is that a template exists in each `/layouts/TYPE` directory with the same name. ### Create a corresponding archetype Create a file called type.md in the `/archetypes` directory. *E.g. `/archetypes/post.md`*. More details about archetypes can be found at the [archetypes docs](/content/archetypes/). hugo-0.18.1/docs/content/extras/000077500000000000000000000000001303124201100164365ustar00rootroot00000000000000hugo-0.18.1/docs/content/extras/aliases.md000066400000000000000000000052601303124201100204040ustar00rootroot00000000000000--- aliases: - /doc/redirects/ - /doc/alias/ - /doc/aliases/ lastmod: 2015-12-23 date: 2013-07-09 menu: main: parent: extras next: /extras/analytics prev: /taxonomies/methods title: Aliases --- For people migrating existing published content to Hugo, there's a good chance you need a mechanism to handle redirecting old URLs. Luckily, redirects can be handled easily with _aliases_ in Hugo. ## Example Given a post on your current Hugo site, with a path of: ``content/posts/my-awesome-blog-post.md`` ... you create an "aliases" section in the frontmatter of your post, and add previous paths to that. ### TOML frontmatter ```toml +++ ... aliases = [ "/posts/my-original-url/", "/2010/01/01/even-earlier-url.html" ] ... +++ ``` ### YAML frontmatter ```yaml --- ... aliases: - /posts/my-original-url/ - /2010/01/01/even-earlier-url.html ... --- ``` Now when you visit any of the locations specified in aliases, _assuming the same site domain_, you'll be redirected to the page they are specified on. ## Important Behaviors 1. *Hugo makes no assumptions about aliases. They also don't change based on your UglyURLs setting. You need to provide absolute path to your webroot and the complete filename or directory.* 2. *Aliases are rendered prior to any content and will be overwritten by any content with the same location.* ## Multilingual example On [multilingual sites]({{< relref "content/multilingual.md" >}}), each translation of a post can have unique aliases. To use the same alias across multiple languages, prefix it with the language code. In `/posts/my-new-post.es.md`: ```yaml --- aliases: - /es/posts/my-original-post/ --- ``` ## How Hugo Aliases Work When aliases are specified, Hugo creates a physical folder structure to match the alias entry, and, an html file specifying the canonical URL for the page, and a redirect target. Assuming a baseURL of `mysite.tld`, the contents of the html file will look something like: ```html http://mysite.tld/posts/my-original-url ``` The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case. ## Customizing You may customize this alias page by creating an alias.html template in the layouts folder of your site. In this case, the data passed to the template is * Permalink - the link to the page being aliased * Page - the Page data for the page being aliased hugo-0.18.1/docs/content/extras/analytics.md000066400000000000000000000012141303124201100207450ustar00rootroot00000000000000--- date: 2016-02-06 linktitle: Analytics menu: main: parent: extras next: /extras/builders prev: /extras/aliases title: Analytics in Hugo --- Hugo ships with prebuilt internal templates for Google Analytics tracking, including both synchronous and asynchronous tracking codes. ## Configuring Google Analytics Provide your tracking id in your configuration file, e.g. config.yaml. googleAnalytics = "UA-123-45" ## Example Include the internal template in your templates like so: {{ template "_internal/google_analytics.html" . }} For async include the async template: {{ template "_internal/google_analytics_async.html" . }} hugo-0.18.1/docs/content/extras/builders.md000066400000000000000000000031541303124201100205740ustar00rootroot00000000000000--- lastmod: 2015-12-24 date: 2014-05-26 linktitle: Builders menu: main: parent: extras next: /extras/comments prev: /extras/analytics title: Hugo Builders --- Hugo provides the functionality to quickly get a site, theme or page started. ## New Site Want to get a site built quickly? {{< nohighlight >}}$ hugo new site path/to/site {{< /nohighlight >}} Hugo will create all the needed directories and files to get started quickly. Hugo will only touch the files and create the directories (in the right places), [configuration](/overview/configuration/) and content are up to you... but luckily we have builders for content (see below). ## New Theme Want to design a new theme? $ hugo new theme THEME_NAME Run from your working directory, this will create a new theme with all the needed files in your themes directory. Hugo will provide you with a license and theme.toml file with most of the work done for you. Follow the [Theme Creation Guide](/themes/creation/) once the builder is done. ## New Content You will use this builder the most of all. Every time you want to create a new piece of content, the content builder will get you started right. Leveraging [content archetypes](/content/archetypes/) the content builder will not only insert the current date and appropriate metadata, but it will pre-populate values based on the content type. $ hugo new relative/path/to/content This assumes it is being run from your working directory and the content path starts from your content directory. Now, Hugo watches your content directory by default and rebuilds your entire website if any change occurs. hugo-0.18.1/docs/content/extras/comments.md000066400000000000000000000072251303124201100206130ustar00rootroot00000000000000--- lastmod: 2015-08-04 date: 2014-05-26 linktitle: Comments menu: main: parent: extras next: /extras/crossreferences prev: /extras/builders title: Comments in Hugo --- As Hugo is a static site generator, the content produced is static and doesn’t interact with the users. The most common interaction people ask for is comment capability. Hugo ships with support for [Disqus](https://disqus.com/), a third-party service that provides comment and community capabilities to website via JavaScript. Your theme may already support Disqus, but even it if doesn’t, it is easy to add. # Disqus Support ## Adding Disqus to a template Hugo comes with all the code you would need to include load Disqus. Simply include the following line where you want your comments to appear: {{ template "_internal/disqus.html" . }} ## Configuring Disqus That template requires you to set a single value in your site config file, e.g. config.yaml. disqusShortname = "XYW" Additionally, you can optionally set the following in the front matter for a given piece of content: * **disqus_identifier** * **disqus_title** * **disqus_url** ## Conditional Loading of Disqus Comments Users have noticed that enabling Disqus comments when running the Hugo web server on localhost causes the creation of unwanted discussions on the associated Disqus account. In order to prevent this, a slightly tweaked partial template is required. So, rather than using the built-in `"_internal/disqus.html"` template referenced above, create a template in your `partials` folder that looks like this: ```html
comments powered by Disqus ``` Notice that there is a simple `if` statement that detects when you are running on localhost and skips the initialization of the Disqus comment injection. Now, reference the partial template from your page template: {{ partial "disqus.html" . }} # Alternatives A few alternatives exist to [Disqus](https://disqus.com/): * [Discourse](http://www.discourse.org) * [IntenseDebate](http://intensedebate.com/) * [Livefyre](http://livefyre.com/) * [Muut](http://muut.com/) * [多说](http://duoshuo.com/) ([Duoshuo](http://duoshuo.com/), popular in China) * [isso](http://posativ.org/isso/) (Self-hosted, Python) * [Kaiju](https://github.com/spf13/kaiju) ## Kaiju [Kaiju](https://github.com/spf13/kaiju) is an open-source project started by [spf13](http://spf13.com/) (Hugo’s author) to bring easy and fast real time discussions to the web. Written using Go, Socket.io and MongoDB, it is very fast and easy to deploy. It is in early development but shows promise. If you have interest, please help by contributing whether via a pull request, an issue or even just a tweet. Everything helps. ## Discourse Additionally, you may recognize [Discourse](http://www.discourse.org) as the system that powers the [Hugo Discussion Forum](http://discuss.gohugo.io). hugo-0.18.1/docs/content/extras/crossreferences.md000066400000000000000000000161461303124201100221630ustar00rootroot00000000000000--- lastmod: 2015-12-23 date: 2014-11-25 menu: main: parent: extras next: /extras/robots-txt prev: /extras/comments title: Cross-References toc: true --- Hugo makes it easy to link documents together with the `ref` and `relref` shortcodes. These shortcodes are also used to safely provide links to headings inside of your content, whether across documents or within a document. The only difference between `ref` and `relref` is whether the resulting URL is absolute (`http://1.com/about/`) or relative (`/about/`). ## Using `ref` and `relref` ```django {{}} {{}} {{}} {{}} {{}} {{}} ``` The single parameter to `ref` is a string with a content _document name_ (`about.md`), an in-document _anchor_ (`#who`), or both (`about.md#who`). ### Document Names The _document name_ is the name of a document including the format extension; this may be just the filename, or the relative path from the `content/` directory. With a document `content/blog/post.md`, either format will produce the same result. {{}} ⇒ `/blog/post/` {{}} ⇒ `/blog/post/` If you have multiple sections with the same filename, you should only use the relative path format, because the behaviour is _undefined_. So, if I also have a document `link/post.md`, the output of `ref` is unknown for `post.md`. {{}} ⇒ `/blog/post/` {{}} ⇒ `/blog/post/` (maybe) {{}} ⇒ `/link/post/` (maybe) {{}} ⇒ `/link/post/` A relative document name must *not* begin with a slash (`/`). {{}} ⇒ `""` ### Anchors When an _anchor_ is provided by itself, the current page’s unique identifier will be appended; when an _anchor_ is provided with a document name, the found page's unique identifier will be appended. {{}} ⇒ `#who:9decaf7` {{}} ⇒ `/blog/post/#who:badcafe` More information about document unique identifiers and headings can be found [below]({{< ref "#hugo-heading-anchors" >}}). ### Examples * `{{}}` ⇒ `http://1.com/blog/post/` * `{{}}` ⇒ `http://1.com/blog/post/#tldr:caffebad` * `{{}}` ⇒ `/blog/post/` * `{{}}` ⇒ `/blog/post/#tldr:caffebad` * `{{}}` ⇒ `#tldr:badcaffe` * `{{}}` ⇒ `#tldr:badcaffe` ## Hugo Heading Anchors When using Markdown document types, Hugo generates heading anchors automatically. The generated anchor for this section is `hugo-heading-anchors`. Because the heading anchors are generated automatically, Hugo takes some effort to ensure that heading anchors are unique both inside a document and across the entire site. Ensuring heading uniqueness across the site is accomplished with a unique identifier for each document based on its path. Unless a document is renamed or moved between sections *in the filesystem*, the unique identifier for the document will not change: `blog/post.md` will always have a unique identifier of `81df004c333b392d34a49fd3a91ba720`. `ref` and `relref` were added so you can make these reference links without having to know the document’s unique identifier. (The links in document tables of contents are automatically up-to-date with this value.) {{}} /extras/crossreferences/#hugo-heading-anchors:77cd9ea530577debf4ce0f28c8dca242 > What follows is a deeper discussion of *why* and *how* Hugo generates heading anchors. It is not necessary to know this to use `ref` and `relref`, but it may be useful in understanding how some anchors may not match your expectations. ### How to Generate a Heading Anchor Convert the text of the heading to lowercase. Hugo: A Fast & Modern Static Web Engine hugo: a fast & modern static web engine Replace anything that isn't an ASCII letter (`a-z`) or number (`0-9`) with a dash (`-`). hugo: a fast & modern static web engine hugo--a-fast---modern-static-web-engine Get rid of extra dashes. hugo--a-fast---modern-static-web-engine hugo-a-fast-modern-static-web-engine You have just converting the text of a heading to a suitable anchor. If your document has unique heading text, all of the anchors will be unique, too. #### Specifying Heading Anchors You can also tell Hugo to use a particular heading anchor. # Hugo: A Fast & Modern Static Web Engine {#hugo-main} Hugo will use `hugo-main` as the heading anchor. ### What About Duplicate Heading Anchors? The technique outlined above works well enough, but some documents have headings with identical text, like the [shortcodes](/extras/shortcodes/) page—there are three headings with the text "Example". You can specify heading anchors manually: ### Example {#example-1} ### Example {#example-2} ### Example {#example-3} It’s easy to forget to do that all the time, and Hugo is smart enough to do it for you. It just adds `-x` to the end of each heading it has already seen. * `### Example` ⇒ `example` * `### Example` ⇒ `example-1` * `### Example` ⇒ `example-2` Sometimes it's a little harder, but Hugo can recover from those, too, by adding more suffixes: * `# Heading` ⇒ `heading` * `# Heading 1` ⇒ `heading-1` * `# Heading` ⇒ `heading-1-1` * `# Heading` ⇒ `heading-1-2` * `# Heading 1` ⇒ `heading-2` This can even affect specified heading anchors that come after a generated heading anchor. * `# My Heading` ⇒ `my-heading` * `# My Heading {#my-heading}` ⇒ `my-heading-1` > This particular collision and override is unfortunate, but unavoidable because Hugo processes each heading for collision detection as it sees it during conversion. This technique works well for documents rendered on individual pages, like blog posts. What about on Hugo list pages? ### Unique Heading Anchors in Lists Hugo converts each document from Markdown independently. it doesn’t know that `blog/post.md` has an "Example" heading that will collide with the "Example" heading in `blog/post2.md`. Even if it did know this, the addition of `blog/post3.md` should not cause the anchors for the headings in the other blog posts to change. Enter the document’s unique identifier. To prevent this sort of collision on list pages, Hugo always appends the document's to a generated heading anchor. So, the "Example" heading in `blog/post.md` actually turns into `#example:81df004…`, and the "Example" heading in `blog/post2.md` actually turns into `#example:8cf1599…`. All you have to know is the heading anchor that was generated, not the document identifier; `ref` and `relref` take care of the rest for you. Post Example Post Example [Post Two Example]({{}}) Post Two Example Now you know. hugo-0.18.1/docs/content/extras/datadrivencontent.md000066400000000000000000000110251303124201100224730ustar00rootroot00000000000000--- aliases: - /doc/datadrivencontent/ lastmod: 2016-03-03 date: 2015-02-14 menu: main: parent: extras next: /extras/gitinfo prev: /extras/datafiles title: Data-driven Content toc: true --- Data-driven content with a static site generator? Yes, it is possible! In addition to the [data files](/extras/datafiles/) feature, we have also implemented the feature "Data-driven Content", which lets you load any [JSON](http://www.json.org/) or [CSV](http://en.wikipedia.org/wiki/Comma-separated_values) file from nearly any resource. "Data-driven Content" currently consists of two functions, `getJSON` and `getCSV`, which are available in **all template files**. ## Implementation details ### Calling the functions with an URL In any HTML template or Markdown document, call the functions like this: {{ $dataJ := getJSON "url" }} {{ $dataC := getCSV "separator" "url" }} or, if you use a prefix or postfix for the URL, the functions accept [variadic arguments](http://en.wikipedia.org/wiki/Variadic_function): {{ $dataJ := getJSON "url prefix" "arg1" "arg2" "arg n" }} {{ $dataC := getCSV "separator" "url prefix" "arg1" "arg2" "arg n" }} The separator for `getCSV` must be put in the first position and can only be one character long. All passed arguments will be joined to the final URL; for example: {{ $urlPre := "https://api.github.com" }} {{ $gistJ := getJSON $urlPre "/users/GITHUB_USERNAME/gists" }} will resolve internally to: {{ $gistJ := getJSON "https://api.github.com/users/GITHUB_USERNAME/gists" }} Finally, you can range over an array. This example will output the first 5 gists for a GitHub user:
    {{ $urlPre := "https://api.github.com" }} {{ $gistJ := getJSON $urlPre "/users/GITHUB_USERNAME/gists" }} {{ range first 5 $gistJ }} {{ if .public }}
  • {{ .description }}
    • {{ end }} {{ end }}
### Example for CSV files For `getCSV`, the one-character long separator must be placed in the first position followed by the URL. {{ $url := "http://a-big-corp.com/finance/employee-salaries.csv" }} {{ $sep := "," }} {{ range $i, $r := getCSV $sep $url }} {{ end }}
Name Position Salary
{{ index $r 0 }} {{ index $r 1 }} {{ index $r 2 }}
The expression `{{index $r number}}` must be used to output the nth-column from the current row. ### Caching of URLs Each downloaded URL will be cached in the default folder `$TMPDIR/hugo_cache/`. The variable `$TMPDIR` will be resolved to your system-dependent temporary directory. With the command-line flag `--cacheDir`, you can specify any folder on your system as a caching directory. You can also set `cacheDir` in the main configuration file. If you don't like caching at all, you can fully disable caching with the command line flag `--ignoreCache`. ### Authentication when using REST URLs Currently, you can only use those authentication methods that can be put into an URL. [OAuth](http://en.wikipedia.org/wiki/OAuth) or other authentication methods are not implemented. ### Loading local files To load local files with the two functions `getJSON` and `getCSV`, the source files must reside within Hugo's working directory. The file extension does not matter but the content does. It applies the same output logic as in the topic: *Calling the functions with an URL*. ## LiveReload There is no chance to trigger a [LiveReload](/extras/livereload/) when the content of an URL changes. However, when a local JSON/CSV file changes, then a LiveReload will be triggered of course. Symlinks are not supported. **URLs and LiveReload**: If you change any local file and the LiveReload is triggered, Hugo will either read the URL content from the cache or, if you have disabled the cache, Hugo will re-download the content. This can create huge traffic and you may also reach API limits quickly. As downloading of content takes a while, Hugo stops processing your Markdown files until the content has been downloaded. ## Examples - Photo gallery JSON powered: [https://github.com/pcdummy/hugo-lightslider-example](https://github.com/pcdummy/hugo-lightslider-example) - GitHub Starred Repositories [in a posts](https://github.com/SchumacherFM/blog-cs/blob/master/content%2Fposts%2Fgithub-starred.md) with the related [short code](https://github.com/SchumacherFM/blog-cs/blob/master/layouts%2Fshortcodes%2FghStarred.html). - More? Please tell us! hugo-0.18.1/docs/content/extras/datafiles.md000066400000000000000000000103401303124201100207120ustar00rootroot00000000000000--- aliases: - /doc/datafiles/ lastmod: 2015-08-04 date: 2015-01-22 menu: main: parent: extras next: /extras/datadrivencontent prev: /extras/robots-txt title: Data Files --- In addition to the [built-in variables](/templates/variables/) available from Hugo, you can specify your own custom data that can be accessed via templates or shortcodes. Hugo supports loading data from [YAML](http://yaml.org/), [JSON](http://www.json.org/), and [TOML](https://github.com/toml-lang/toml) files located in the `data` directory. **It even works with [LiveReload](/extras/livereload/).** Data Files can also be used in [themes](/themes/overview/), but note: If the same `key` is used in both the main data folder and in the theme's data folder, the main one will win. So, for theme authors, for theme specific data items that shouldn't be overridden, it can be wise to prefix the folder structure with a namespace, e.g. `mytheme/data/mytheme/somekey/...`. To check if any such duplicate exists, run hugo with the `-v` flag, e.g. `hugo -v`. ## The Data Folder The `data` folder is where you can store additional data for Hugo to use when generating your site. Data files aren't used to generate standalone pages - rather they're meant supplemental to the content files. This feature can extend the content in case your frontmatter would grow immensely. Or perhaps your want to show a larger dataset in a template (see example below). In both cases it's a good idea to outsource the data in their own file. These files must be YAML, JSON or TOML files (using either the `.yml`, `.yaml`, `.json` or `toml` extension) and the data will be accessible as a `map` in `.Site.Data`. **The keys in this map will be a dot chained set of _path_, _filename_ and _key_ in file (if applicable).** This is best explained with an example: ## Example: Jaco Pastorius' Solo Discography [Jaco Pastorius](http://en.wikipedia.org/wiki/Jaco_Pastorius_discography) was a great bass player, but his solo discography is short enough to use as an example. [John Patitucci](http://en.wikipedia.org/wiki/John_Patitucci) is another bass giant. The example below is a bit constructed, but it illustrates the flexibility of Data Files. It uses TOML as file format. Given the files: * `data/jazz/bass/jacopastorius.toml` * `data/jazz/bass/johnpatitucci.toml` `jacopastorius.toml` contains the content below, `johnpatitucci.toml` contains a similar list: ``` discography = [ "1974 – Modern American Music … Period! The Criteria Sessions", "1974 – Jaco", "1976 - Jaco Pastorius", "1981 - Word of Mouth", "1981 - The Birthday Concert (released in 1995)", "1982 - Twins I & II (released in 1999)", "1983 - Invitation", "1986 - Broadway Blues (released in 1998)", "1986 - Honestly Solo Live (released in 1990)", "1986 - Live In Italy (released in 1991)", "1986 - Heavy'n Jazz (released in 1992)", "1991 - Live In New York City, Volumes 1-7.", "1999 - Rare Collection (compilation)", "2003 - Punk Jazz: The Jaco Pastorius Anthology (compilation)", "2007 - The Essential Jaco Pastorius (compilation)" ] ``` The list of bass players can be accessed via `.Site.Data.jazz.bass`, a single bass player by adding the filename without the suffix, e.g. `.Site.Data.jazz.bass.jacopastorius`. You can now render the list of recordings for all the bass players in a template: ``` {{ range $.Site.Data.jazz.bass }} {{ partial "artist.html" . }} {{ end }} ``` And then in `partial/artist.html`: ```
    {{ range .discography }}
  • {{ . }}
    • {{ end }}
``` Discover a new favourite bass player? Just add another TOML-file. ## Example: Accessing named values in a Data File Assuming you have the following YAML structure to your `User0123.yml` Data File located directly in `data/` ``` Name: User0123 "Short Description": "He is a **jolly good** fellow." Achievements: - "Can create a Key, Value list from Data File" - "Learns Hugo" - "Reads documentation" ``` To render the `Short Description` in your `layout` File following code is required. ```
Short Description of {{.Site.Data.User0123.Name}}:

{{ index .Site.Data.User0123 "Short Description" | markdownify }}

``` Note the use of the `markdownify` template function. This will send the description through the Blackfriday Markdown rendering engine. hugo-0.18.1/docs/content/extras/gitinfo.md000066400000000000000000000021351303124201100204200ustar00rootroot00000000000000--- aliases: - /doc/gitinfo/ lastmod: 2016-12-11 date: 2016-12-11 menu: main: parent: extras next: /extras/livereload prev: /extras/datadrivencontent title: GitInfo --- Hugo provides a way to integrate Git data into your site. ## Prerequisites 1. The Hugo site must be in a Git-enabled directory. 1. The Git executable must be installed and in your system `PATH`. 1. Enable the GitInfo feature in Hugo by using `--enableGitInfo` on the command line or by setting `enableGitInfo` to `true` in your site configuration. ## The GitInfo Object The `GitInfo` object contains the following fields: AbbreviatedHash : abbreviated commit hash, e.g. `866cbcc` AuthorName : author name, respecting `.mailmap` AuthorEmail : author email address, respecting `.mailmap` AuthorDate : the author date Hash : commit hash, e.g. `866cbccdab588b9908887ffd3b4f2667e94090c3` Subject : commit message subject, e.g. `tpl: Add custom index function` ## Performance Considerations The Git integrations should be fairly performant, but it does add some time to the build, which depends somewhat on the Git history size. hugo-0.18.1/docs/content/extras/highlighting.md000066400000000000000000000177741303124201100214450ustar00rootroot00000000000000--- aliases: - /extras/highlight/ lastmod: 2015-10-27 date: 2013-07-01 menu: main: parent: extras next: /extras/toc prev: /extras/shortcodes title: Syntax Highlighting toc: true --- Hugo provides the ability for you to highlight source code in _two different ways_ — either pre-processed server side from your content, or to defer the processing to the client side, using a JavaScript library. **The advantage of server side** is that it doesn’t depend on a JavaScript library and consequently works very well when read from an RSS feed. **The advantage of client side** is that it doesn’t cost anything when building your site and some of the highlighting scripts available cover more languages than Pygments does. ## Server-side For the pre-processed approach, highlighting is performed by an external Python-based program called [Pygments](http://pygments.org/) and is triggered via an embedded Hugo shortcode (see example below). If Pygments is absent from the path, it will silently simply pass the content along unhighlighted. ### Pygments If you have never worked with Pygments before, here is a brief primer: + Install Python from [python.org](https://www.python.org/downloads/). Version 2.7.x is already sufficient. + Run `pip install Pygments` in order to install Pygments. Once installed, Pygments gives you a command `pygmentize`. Make sure it sits in your PATH, otherwise Hugo cannot find it. On Debian and Ubuntu systems, you may also install Pygments by running `sudo apt-get install python3-pygments`. Hugo gives you two options that you can set with the variable `pygmentsuseclasses` (default `false`) in `config.toml` (or `config.yaml`). 1. Color-codes for highlighting keywords are directly inserted if `pygmentsuseclasses = false` (default). See in the example below. The color-codes depend on your choice of the `pygmentsstyle` (default `"monokai"`). You can explore the different color styles on [pygments.org](http://pygments.org/) after inserting some example code. 2. If you choose `pygmentsuseclasses = true`, Hugo includes class names in your code instead of color-codes. For class-names to be meaningful, you need to include a `.css`-file in your website representing your color-scheme. You can either generate this `.css`-files according to this [description](http://pygments.org/docs/cmdline/) or download the standard ones from the [GitHub pygments-css repository](https://github.com/richleland/pygments-css). ### Usage Highlighting is carried out via the in-built shortcode `highlight`. `highlight` takes exactly one required parameter of language, and requires a closing shortcode. Note that `highlight` is _not_ used for client-side javascript highlighting. ### Example ``` {{}}

{{ .Title }}

{{ range .Data.Pages }} {{ .Render "summary"}} {{ end }}
{{}} ``` ### Example Output ``` <section id="main"> <div> <h1 id="title">{{ .Title }}</h1> {{ range .Data.Pages }} {{ .Render "summary"}} {{ end }} </div> </section> ``` ### Options Options to control highlighting can be added as a quoted, comma separated key-value list as the second argument in the shortcode. The example below will highlight as language `go` with inline line numbers, with line number 2 and 3 highlighted. ``` {{}} var a string var b string var c string var d string {{}} ``` Supported keywords: `style`, `encoding`, `noclasses`, `hl_lines`, `linenos`. Note that `style` and `noclasses` will override the similar setting in the global config. The keywords are the same you would using with Pygments from the command line, see the [Pygments doc](http://pygments.org/docs/) for more info. ### Code fences It is also possible to add syntax highlighting with GitHub flavoured code fences. To enable this, set the `PygmentsCodeFences` to `true` in Hugo's configuration file. ```` ``` html

{{ .Title }}

{{ range .Data.Pages }} {{ .Render "summary"}} {{ end }}
``` ```` ### Disclaimers * Pygments is relatively slow and _causes a performance hit when building your site_, but Hugo has been designed to cache the results to disk. * The caching can be turned off by setting the `--ignoreCache` flag to `true`. * Languages available depends on your Pygments installation. ## Client-side Alternatively, code highlighting can be done in client-side JavaScript. Client-side syntax highlighting is very simple to add. You'll need to pick a library and a corresponding theme. Some popular libraries are: - [Highlight.js] - [Prism] - [Rainbow] - [Syntax Highlighter] - [Google Prettify] ### Highlight.js example This example uses the popular [Highlight.js] library, hosted by [Yandex], a popular Russian search engine. In your `./layouts/partials/` (or `./layouts/chrome/`) folder, depending on your specific theme, there will be a snippet that will be included in every generated HTML page, such as `header.html` or `header.includes.html`. Simply add the css and js to initialize [Highlight.js]: ~~~ ~~~ ### Prism example Prism is another popular highlighter library, used on some major sites. Similar to Highlight.js, you simply load `prism.css` in your `` via whatever Hugo partial template is creating that part of your pages, like so: ```html ... ... ``` ... and add `prism.js` near the bottom of your `` tag, again in whatever Hugo partial template is appropriate for your site or theme. ```html ... ... ``` In this example, the local paths indicate that your own copy of these files are being added to the site, typically under `./static/`. ### Using Client-side highlighting To use client-side highlighting, most of these javascript libraries expect your code to be wrapped in semantically correct `` tags, with the language expressed in a class attribute on the `` tag, such as `class="language-abc"`, where the `abc` is the code the highlighter script uses to represent that language. The script would be looking for classes like `language-go`, `language-html`, or `language-css`. If you look at the page's source, it would be marked up like so: ~~~html 

body {
  font-family: "Noto Sans", sans-serif;
}
~~~ The markup in your content pages (e.g. `my-css-tutorial.md`) needs to look like the following, with the name of the language to be highlighted entered directly after the first "fence", in a fenced code block: 
~~~css
body {
  font-family: "Noto Sans", sans-serif;
}
~~~
When passed through the highlighter script, it would yield something like this output when viewed on your rendered page: ~~~css body { font-family: "Noto Sans", sans-serif; } ~~~ Please see individual libraries' documentation for how to implement each of the JavaScript-based libraries. [Prism]: http://prismjs.com [Highlight.js]: http://highlightjs.org/ [Rainbow]: http://craig.is/making/rainbows [Syntax Highlighter]: http://alexgorbatchev.com/SyntaxHighlighter/ [Google Prettify]: https://github.com/google/code-prettify [Yandex]: http://yandex.ru/ hugo-0.18.1/docs/content/extras/livereload.md000066400000000000000000000043451303124201100211140ustar00rootroot00000000000000--- lastmod: 2016-08-09 date: 2014-05-26 menu: main: parent: extras next: /extras/menus prev: /extras/gitinfo title: LiveReload --- Hugo may not be the first static site generator to utilize LiveReload technology, but it’s the first to do it right. The combination of Hugo’s insane build speed and LiveReload make crafting your content pure joy. Virtually instantly after you hit save your rebuilt content will appear in your browser. ## Using LiveReload Hugo comes with LiveReload built in. There are no additional packages to install. A common way to use Hugo while developing a site is to have Hugo run a server and watch for changes: {{< nohighlight >}}$ hugo server {{< /nohighlight >}} This will run a full functioning web server while simultaneously watching your file system for additions, deletions or changes within your: * static files * content * data files * layouts * current theme * configuration files Whenever anything changes, Hugo will rebuild the site while continuing to serve the content. As soon as the build is finished, it will tell the browser and silently reload the page. Because most Hugo builds are so fast they are barely noticeable, you merely need to glance at your open browser and you will see the change, already there. This means that keeping the site open on a second monitor (or another half of your current monitor) allows you to see exactly what your content looks like, without even leaving your text editor. ## Disabling Watch If for some reason you don't want the Hugo server's watch functionality, just do: {{< nohighlight >}}$ hugo server --watch=false {{< /nohighlight >}} ## Disabling LiveReload LiveReload works by injecting JavaScript into the pages Hugo generates, which creates a connection from the browser web socket client to the Hugo web socket server. Awesome for development, but not something you would want to do in production. Since many people use `hugo server` in production to instantly display any updated content, we’ve made it easy to disable the LiveReload functionality: {{< nohighlight >}}$ hugo server --disableLiveReload {{< /nohighlight >}} ## Notes You must have a closing `` tag for LiveReload to work. Hugo injects the LiveReload ` Extract the value from the field `data-id` and pass it to the shortcode: {{}} ### Instagram If you'd like to embed photo from [Instagram](https://www.instagram.com/), all you need is photo ID from the URL, e. g.: * https://www.instagram.com/p/BMokmydjG-M/ Pass it to the shortcode: {{}} Optionally, hide caption: {{}} ## Creating your own shortcodes To create a shortcode, place a template in the layouts/shortcodes directory. The template name will be the name of the shortcode. In creating a shortcode, you can choose if the shortcode will use _positional parameters_, or _named parameters_, or _both_. A good rule of thumb is that if a shortcode has a single required value in the case of the `youtube` example below, then positional works very well. For more complex layouts with optional parameters, named parameters work best. Allowing both types of parameters is useful for complex layouts where you want to set default values that can be overridden. **Inside the template** To access a parameter by position, the `.Get` method can be used: {{ .Get 0 }} To access a parameter by name, the `.Get` method should be utilized: {{ .Get "class" }} `with` is great when the output depends on a parameter being set: {{ with .Get "class"}} class="{{.}}"{{ end }} `.Get` can also be used to check if a parameter has been provided. This is most helpful when the condition depends on either one value or another... or both: {{ or .Get "title" | .Get "alt" | if }} alt="{{ with .Get "alt"}}{{.}}{{else}}{{.Get "title"}}{{end}}"{{ end }} If a closing shortcode is used, the variable `.Inner` will be populated with all of the content between the opening and closing shortcodes. If a closing shortcode is required, you can check the length of `.Inner` and provide a warning to the user. A shortcode with `.Inner` content can be used without the inline content, and without the closing shortcode, by using the self-closing syntax: {{}} The variable `.Params` contains the list of parameters in case you need to do more complicated things than `.Get`. It is sometimes useful to provide a flexible shortcode that can take named or positional parameters. To meet this need, Hugo shortcodes have a `.IsNamedParams` boolean available that can be used such as `{{ if .IsNamedParams }}...{{ else }}...{{ end }}`. See the `Single Flexible Example` below for an example. You can also use the variable `.Page` to access all the normal [Page Variables](/templates/variables/). A shortcodes can be nested. In a nested shortcode you can access the parent shortcode context with `.Parent`. This can be very useful for inheritance of common shortcode parameters from the root. ## Single Positional Example: youtube {{}} Would load the template /layouts/shortcodes/youtube.html
This would be rendered as:
## Single Named Example: image with caption {{}} Would load the template /layouts/shortcodes/img.html
{{ with .Get "link"}}{{ end }} {{ if .Get "link"}}{{ end }} {{ if or (or (.Get "title") (.Get "caption")) (.Get "attr")}}
{{ if isset .Params "title" }}

{{ .Get "title" }}

{{ end }} {{ if or (.Get "caption") (.Get "attr")}}

{{ .Get "caption" }} {{ with .Get "attrlink"}} {{ end }} {{ .Get "attr" }} {{ if .Get "attrlink"}} {{ end }}

{{ end }}
{{ end }}
Would be rendered as:

Steve Francia

## Single Flexible Example: vimeo with defaults {{}} {{}} Would load the template /layouts/shortcodes/vimeo.html {{ if .IsNamedParams }}
{{ else }}
{{ end }} Would be rendered as:
## Paired Example: Highlight *Hugo already ships with the `highlight` shortcode* {{}} This HTML {{}} The template for this utilizes the following code (already included in Hugo) {{ .Get 0 | highlight .Inner }} And will be rendered as: 
<html>
        <body> This HTML </body>
    </html>
Please notice that this template makes use of a Hugo-specific template function called `highlight` which uses Pygments to add the highlighting code. ## Simple Single-word Example: Year Let's assume you would like to have a shortcode to be replaced by the current year in your Markdown content files, for a license or copyright statement. Calling a shortcode like this: {{}} ... would load your one-line template ``/layouts/shortcodes/year.html``, which contains: {{ .Page.Now.Year }} More shortcode examples can be found at [spf13.com](https://github.com/spf13/spf13.com/tree/master/layouts/shortcodes). hugo-0.18.1/docs/content/extras/toc.md000066400000000000000000000015201303124201100175430ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2013-07-09 menu: main: parent: extras next: /extras/localfiles prev: /extras/highlighting title: Table of Contents --- Hugo will automatically parse the Markdown for your content and create a Table of Contents you can use to guide readers to the sections within your content. ## Usage Simply create content like you normally would with the appropriate headers. Hugo will take this Markdown and create a table of contents stored in the [content variable](/layout/variables/) `.TableOfContents` ## Template Example This is example code of a [single.html template](/layout/content/). {{ partial "header.html" . }}
{{ .TableOfContents }}

{{ .Title }}

{{ .Content }} {{ partial "footer.html" . }} hugo-0.18.1/docs/content/extras/urls.md000066400000000000000000000055451303124201100177560ustar00rootroot00000000000000--- aliases: - /doc/urls/ lastmod: 2016-05-07 date: 2014-01-03 menu: main: parent: extras next: /community/mailing-list notoc: true prev: /extras/localfiles title: URLs --- ## Pretty URLs By default, Hugo creates content with 'pretty' URLs. For example, content created at `/content/extras/urls.md` will be rendered at `/public/extras/urls/index.html`, thus accessible from the browser at http://example.com/extras/urls/. No non-standard server-side configuration is required for these pretty URLs to work. If you would like to have what we call "ugly URLs", e.g. http://example.com/extras/urls.html, you are in luck. Hugo supports the ability to create your entire site with ugly URLs. Simply add `uglyurls = true` to your site-wide `config.toml`, or use the `--uglyURLs=true` flag on the command line. If you want a specific piece of content to have an exact URL, you can specify this in the front matter under the `url` key. See [Content Organization](/content/organization/) for more details. ## Canonicalization By default, all relative URLs encountered in the input are left unmodified, e.g. `/css/foo.css` would stay as `/css/foo.css`, i.e. `canonifyURLs` defaults to `false`. By setting `canonifyURLs` to `true`, all relative URLs would instead be *canonicalized* using `baseURL`. For example, assuming you have `baseURL = http://yoursite.example.com/` defined in the site-wide `config.toml`, the relative URL `/css/foo.css` would be turned into the absolute URL `http://yoursite.example.com/css/foo.css`. Benefits of canonicalization include fixing all URLs to be absolute, which may aid with some parsing tasks. Note though that all real browsers handle this client-side without issues. Benefits of non-canonicalization include being able to have resource inclusion be scheme-relative, so that http vs https can be decided based on how this page was retrieved. > Note: In the May 2014 release of Hugo v0.11, the default value of `canonifyURLs` was switched from `true` to `false`, which we think is the better default and should continue to be the case going forward. So, please verify and adjust your website accordingly if you are upgrading from v0.10 or older versions. To find out the current value of `canonifyURLs` for your website, you may use the handy `hugo config` command added in v0.13: hugo config | grep -i canon Or, if you are on Windows and do not have `grep` installed: hugo config | FINDSTR /I canon ## Relative URLs By default, all relative URLs are left unchanged by Hugo, which can be problematic when you want to make your site browsable from a local file system. Setting `relativeURLs` to `true` in the site configuration will cause Hugo to rewrite all relative URLs to be relative to the current content. For example, if the `/post/first/` page contained a link with a relative URL of `/about/`, Hugo would rewrite that URL to `../../about/`. hugo-0.18.1/docs/content/meta/000077500000000000000000000000001303124201100160565ustar00rootroot00000000000000hugo-0.18.1/docs/content/meta/license.md000066400000000000000000000250061303124201100200250ustar00rootroot00000000000000--- aliases: - /doc/license/ - /license/ - /meta/license/ lastmod: 2015-11-25 date: 2013-07-01 menu: main: parent: about title: License weight: 50 --- Hugo v0.15 and later are released under the Apache 2.0 license. Earlier releases were under the Simple Public License. Apache License ============== _Version 2.0, January 2004_ _<>_ ### Terms and Conditions for use, reproduction, and distribution #### 1. Definitions “License” shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. “Licensor” shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. “Legal Entity” shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, “control” means **(i)** the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the outstanding shares, or **(iii)** beneficial ownership of such entity. “You” (or “Your”) shall mean an individual or Legal Entity exercising permissions granted by this License. “Source” form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. “Object” form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. “Work” shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). “Derivative Works” shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. “Contribution” shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, “submitted” means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as “Not a Contribution.” “Contributor” shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. #### 2. Grant of Copyright License Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. #### 3. Grant of Patent License Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. #### 4. Redistribution You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: * **(a)** You must give any other recipients of the Work or Derivative Works a copy of this License; and * **(b)** You must cause any modified files to carry prominent notices stating that You changed the files; and * **(c)** You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and * **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. #### 5. Submission of Contributions Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. #### 6. Trademarks This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. #### 7. Disclaimer of Warranty Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. #### 8. Limitation of Liability In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. #### 9. Accepting Warranty or Additional Liability While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. _END OF TERMS AND CONDITIONS_ ### APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets `[]` replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same “printed page” as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. hugo-0.18.1/docs/content/meta/release-notes.md000066400000000000000000001154751303124201100211630ustar00rootroot00000000000000--- aliases: - /doc/release-notes/ - /meta/release-notes/ date: 2013-07-01 menu: main: parent: about title: Release Notes weight: 10 --- ## **0.18.1** December 30th 2016 Hugo 0.18.1 is a bug fix release fixing some issues introduced in Hugo 0.18: * Fix 32-bit binaries {{}} * Fix issues with `preserveTaxonomyNames` {{}} * Fix `.URL` for taxonomy pages when `uglyURLs=true` {{}} * Fix `IsTranslated` and `Translations` for node pages {{}} * Make template error messages more verbose {{}} ## **0.18.0** December 19th 2016 Today, we're exited to release the much-anticipated Hugo 0.18! We're heading towards the end of the year 2016, and we can look back on three releases and a steady growing community around the project. This release includes **over 220 contributions by nearly 50 contributors** to the main codebase. Since the last release, Hugo has **gained 1750 stars and 27 additional themes**. Hugo now has: - 13750+ stars - 408+ contributors - 137+ themes {{< gh "@bep" >}} once again took the lead of Hugo and contributed a significant amount of additions. Also a big shoutout to {{< gh "@digitalcraftsman" >}} for his relentless work on keeping the documentation and the themes site in pristine condition, and also a big thanks to {{< gh "@moorereason" >}} and {{< gh "@bogem" >}} for their contributions. We wish you all a Merry Christmas and a Happy New Year.
*The Hugo team* ## Highlights The primary new feature in Hugo 0.18 is that every piece of content is now a `Page` ({{}}). This means that every page, including the home page, can have a content file with frontmatter. Not only is this a much simpler model to understand, it is also faster and paved the way for several important new features: * Enable proper titles for Nodes {{}} * Sitemap.xml should include nodes, as well as pages {{}} * Document homepage content workaround {{}} * Allow home page to be easily authored in markdown {{}} * Minimalist website with homepage as content {{}} Hugo again continues its trend of each release being faster than the last. It's quite a challenge to consistently add significant new functionality and simultaneously dramatically improve performance. Running [this benchmark]( https://github.com/bep/hugo-benchmark) with [these sites](https://github.com/bep/hugo-benchmark/tree/master/sites) (renders to memory) shows about 60% reduction in time spent and 30% reduction in memory usage compared to Hugo 0.17. ## Other New Features * Every `Page` now has a `Kind` property. Since everything is a `Page` now, the `Kind` is used to differentiate different kinds of pages. Possible values are `page`, `home`, `section`, `taxonomy`, and `taxonomyTerm`. (Internally, we also define `RSS`, `sitemap`, `robotsTXT`, and `404`, but those have no practical use for end users at the moment since they are not included in any collections.) * Add a `GitInfo` object to `Page` if `enableGitInfo` is set. It then also sets `Lastmod` for the given `Page` to the author date provided by Git. {{}} * Implement support for alias templates {{}} * New template functions: * Add `imageConfig` function {{}} * Add `sha256` function {{}} * Add `partialCached` template function {{}} * Add shortcode to display Instagram images {{}} * Add `noChmod` option to disable perm sync {{}} * Add `quiet` build mode {{}} ## Notices * `.Site.Pages` will now contain *several kinds of pages*, including regular pages, sections, taxonomies, and the home page. If you want a specific kind of page, you can filter it with `where` and `Kind`. `.Site.RegularPages` is a shortcut to the page collection you have been used to getting. * `RSSlink` is now deprecated. Use `RSSLink` instead. Note that in Hugo 0.17 both of them existed, so there is a fifty-fifty chance you will not have to do anything (if you use a theme, the chance is close to 0), and `RSSlink` will still work for two Hugo versions. ## Fixes * Revise the `base` template lookup logic so it now better matches the behavior of regular templates, making it easier to override the master templates from the theme {{}} * Add workaround for `block` template crash. Block templates are very useful, but there is a bug in Go 1.6 and 1.7 which makes the template rendering crash if you use the block template in more complex scenarios. This is fixed in the upcoming Go 1.8, but Hugo adds a temporary workaround in Hugo 0.18. {{}} * All the `Params` configurations are now case insensitive {{}} {{}} {{}} * Make RawContent raw again {{}} * Fix archetype title and date handling {{}} * Fix TOML archetype parsing in `hugo new` {{}} * Fix page sorting when weight is zero {{}} * Fix page names that contain dot {{}} * Fix RSS Title regression {{}} * Handle ToC before handling shortcodes {{}} * Only watch relevant themes dir {{}} * Hugo new content creates TOML slices with closing bracket on new line {{}} ## Improvements * Add page information to error logging in rendering {{}} * Deprecate `RSSlink` in favor of `RSSLink` * Make benchmark command more useful {{}} * Consolidate the `Param` methods {{}} * Allow to set cache dir in config file * Performance improvements: * Avoid repeated Viper loads of `sectionPagesMenu` {{}} * Avoid reading from Viper for path and URL funcs {{}} * Add `partialCached` template function. This can be a significant performance boost if you have complex partials that does not need to be rerendered for every page. {{}} ## Documentation Updates * Update roadmap {{}} * Update multilingual example {{}} * Add a "Deployment with rsync" tutorial page {{}} * Refactor `/docs` to use the `block` keyword {{}} ## **0.17.0** October 7th 2016 Hugo is going global with our 0.17 release. We put a lot of thought into how we could extend Hugo to support multilingual websites with the most simple and elegant experience. Hugo's multilingual capabilities rival the best web and documentation software, but Hugo's experience is unmatched. If you have a single language website, the simple Hugo experience you already love is unchanged. Adding additional languages to your website is simple and straightforward. Hugo has been completely internally rewritten to be multilingual aware with translation and internationalization features embedded throughout Hugo. Hugo continues its trend of each release being faster than the last. It's quite a challenge to consistently add significant new functionality and simultaneously dramatically improve performance. {{}} has made it his personal mission to apply the Go mantra of "Enable more. Do less" to Hugo. Hugo's consistent improvement is a testament to his brilliance and his dedication to his craft. Hugo additionally benefits from the performance improvements from the Go team in the Go 1.7 release. This release represents **over 300 contributions by over 70 contributors** to the main Hugo code base. Since last release Hugo has **gained 2000 stars, 50 new contributors and 20 additional themes.** Hugo now has: * 12,000 stars on GitHub * 370+ contributors * 110+ themes {{}} continues to lead the project with the lionshare of contributions and reviews. A special thanks to {{}} and {{}} for their considerable work on multilingual support. A big welcome to newcomers {{}}, {{}} and {{}} for their critical contributions. ### Highlights **Multilingual Support:** Hugo now supports multiple languages side-by-side. A single site can now have multiple languages rendered with full support for translation and i18n. **Performance:** Hugo is faster than ever! Hugo 0.17 is not only our fastest release, it's also the most efficient. Hugo 0.17 is **nearly twice as fast as Hugo 0.16** and uses about 10% less memory. This means that the same site will build in nearly half the time it took with Hugo 0.16. For the first time Hugo sites are averaging well under 1ms per rendered content. **Docs overhaul:** This release really focused on improving the documentation. [Gohugo.io](http://gohugo.io) is more accurate and complete than ever. **Support for macOS Sierra** ### New Features * Multilingual support {{}} * Allow content expiration {{}} * New templates functions: * `querify` function to generate query strings inside templates {{}} * `htmlEscape` and `htmlUnescape` template functions {{}} * `time` converts a timestamp string into a time.Time structure {{}} ### Enhancements * Render the shortcodes as late as possible {{}} * Remove unneeded casts in page.getParam {{}} * Automatic page date fallback {{}} * Enable safeHTMLAttr {{}} * Add TODO list support for markdown {{}} * Make absURL and relURL accept any type {{}} * Suppress 'missing static' error {{}} * Make summary, wordcount etc. more efficient {{}} * Better error reporting in `hugo convert` {{}} * Reproducible builds thanks to govendor {{}} ### Fixes * Fix shortcode in markdown headers {{}} * Explicitly bind livereload to hugo server port {{}} * Fix Emojify for certain text patterns {{}} * Normalize file name to NFC {{}} * Ignore emacs temp files {{}} * Handle symlink change event {{}} * Fix panic when using URLize {{}} * `hugo import jekyll`: Fixed target path location check {{}} * Return all errors from casting in templates {{}} * Fix paginator counter on x86-32 {{}} * Fix half-broken self-closing shortcodes {{}} **** ## **0.16.0** June 6th 2016 Hugo 0.16 is our best and biggest release ever. The Hugo community has outdone itself with continued performance improvements, [beautiful themes](http://themes.gohugo.io) for all types of sites from project sites to documentation to blogs to portfolios, and increased stability. This release represents **over 550 contributions by over 110 contributors** to the main Hugo code base. Since last release Hugo has **gained 3500 stars, 90 contributors and 23 additional themes.** This release celebrates 3 years since {{< gh "@spf13" >}} wrote the first lines of Hugo. During those 3 years Hugo has accomplished some major milestones including... * 10,000+ stars on GitHub * 320+ contributors * 90+ themes * 1000s of happy websites * Many subprojects like {{< gh "@spf13/cobra">}}, {{< gh "@spf13/viper">}} and {{< gh "@spf13/afero">}} which have experienced broad usage across the Go ecosystem. {{< gh "@bep" >}} led the development of Hugo for the 3rd consecutive release with nearly half of the contributions to 0.16 in addition to his considerable contributions as lead maintainer. {{< gh "@anthonyfok" >}}, {{< gh "@DigitalCraftsman" >}}, {{< gh "@MooreReason" >}} all made significant contributions. A special thanks to {{< gh "@abourget " >}} for his considerable work on multilingual support. Due to its broad impact we wanted to spend more time testing it and it will be included in Hugo's next release. ### Highlights **Partial Builds:** Prior to this release Hugo would always reread and rebuild the entire site. This release introduces support for reactive site building while watching (`hugo server`). Hugo will watch the filesystem for changes and only re-read the changed files. Depending on the files change Hugo will intelligently re-render only the needed portion of the site. Performance gains depend on the operation performed and size of the site. In our testing build times decreased anywhere from 10% to 99%. **Template Improvements:** Template improvements continue to be a mainstay of each Hugo release. Hugo 0.16 adds support for the new `block` keyword introduced in Go 1.6 -- think base templates with default sections -- as well as many new template functions. **Polish:** As Hugo matures releases will inevitably contain fewer huge new features. This release represents hundreds of small improvements across ever facet of Hugo which will make for a much better experience for all of our users. Worth mentioning here is the curious bug where live reloading didn't work in some editors on OS X, including the popular TextMate 2. This is now fixed. Oh, and now any error will exit with an error code, a big thing for automated deployments. ### New Features * Support reading configuration variables from the OS environment {{}} * Add emoji support {{}} * Add `themesDir` option to configuration {{}} * Add support for Go 1.6 `block` keyword in templates {{}} * Partial static sync {{}} * Source file based relative linking (a la Github) {{}} * Add `ByLastmod` sort function to pages. {{}} * New templates functions: * `readFile` {{}} * `countwords` and `countrunes` {{}} * `default` {{}} * `hasPrefix` {{}} * `humanize` {{}} * `jsonify` {{}} * `md5` and `sha1` {{}} * `replaceRE` {{}} * `findRE` {{}} * `shuffle` {{}} * `slice` {{}} * `plainify` {{}} ### Enhancements * Hugo now exits with error code on any error. This is a big thing for automated deployments. {{}} * Print error when `/index.html` is zero-length {{}} * Enable dirname and filename bash autocompletion for more flags {{}} * Improve error handling in commands {{}} * Add sanity checks for `hugo import jekyll` {{}} * Add description to `Page.Params` {{}} * Add async version of Google Analytics internal template {{}} * Add autostart option to YouTube shortcode {{}} * Set Date and Lastmod for main home page {{}} * Allow URL with extension in frontmatter {{}} * Add list support in Scratch {{}} * Add file option to gist shortcode {{}} * Add config layout and content directory CLI options {{}} * Add boolean value comparison to `where` template function {{}} * Do not write to to cache when `ignoreCache` is set {{}} * Add option to disable rendering of 404 page {{}} * Mercurial is no longer needed to build Hugo {{}} * Do not create `robots.txt` by default {{}} * Disable syntax guessing for PygmentsCodeFences by default. To enable syntax guessing again, add the following to your config file: `PygmentsCodeFencesGuessSyntax = true` {{}} * Make `ByCount` sort consistently {{}} * Add `Scratch` to shortcode {{}} * Add support for symbolic links for content, layout, static, theme {{}} * Add '+' as one of the valid characters in URLs specified in the front matter {{}} * Make alias redirect output URLs relative when `RelativeURLs = true` {{}} * Hugo injects meta generator tag on homepage if missing {{}} ### Fixes * Fix file change watcher for TextMate 2 and friends on OS X {{}} * Make dynamic reloading of config file reliable on all platform {{}} * Hugo now works on Linux/arm64 {{}} * `plainIDAnchors` now defaults to `true` {{}} * Win32 and ARM builds fixed {{}} * Copy static dir files without theme's static dir {{}} * Make `noTimes` command flag work {{}} * Change most global CLI flags into local ones {{}} * Remove transformation of menu URLs {{}} * Do not fail on unknown Jekyll file {{}} * Use absolute path when editing with editor {{}} * Fix hugo server "Watching for changes" path display {{}} * Do not strip special characters out of URLs {{}} * Fix `RSSLink` when uglyURLs are enabled {{}} * Get BaseURL from viper in server mode {{}} * Fix shortcode handling in RST {{}} * Use default sitemap configuration for homepage {{}} * Exit if specific port is unavailable in server mode {{}} * Fix regression in "section menus for lazy blogger" {{}} **** ## **0.15.0** November 25, 2015 The v0.15.0 Hugo release brings a lot of polish to Hugo. Exactly 6 months after the 0.14 release, Hugo has seen massive growth and changes. Most notably, this is Hugo's first release under the Apache 2.0 license. With this license change we hope to expand the great community around Hugo and make it easier for our many users to contribute. This release represents over **377 contributions by 87 contributors** to the main Hugo repo and hundreds of improvements to the libraries Hugo uses. Hugo also launched a [new theme showcase](http://themes.gohugo.io) and participated in [Hacktoberfest](https://hacktoberfest.digitalocean.com). Hugo now has: * 6700 (+2700) stars on GitHub * 235 (+75) contributors * 65 (+30) themes **Template Improvements:** This release takes Hugo to a new level of speed and usability. Considerable work has been done adding features and performance to the template system which now has full support of Ace, Amber and Go Templates. **Hugo Import:** Have a Jekyll site, but dreaming of porting it to Hugo? This release introduces a new `hugo import jekyll`command that makes this easier than ever. **Performance Improvements:** Just when you thought Hugo couldn't get any faster, Hugo continues to improve in speed while adding features. Notably Hugo 0.15 introduces the ability to render and serve directly from memory resulting in 30%+ lower render times. Huge thanks to all who participated in this release. A special thanks to {{< gh "@bep" >}} who led the development of Hugo this release again, {{< gh "@anthonyfok" >}}, {{< gh "@eparis" >}}, {{< gh "@tatsushid" >}} and {{< gh "@DigitalCraftsman" >}}. ### New features * new `hugo import jekyll` command. {{< gh 1469 >}} * The new `Param` convenience method on `Page` and `Node` can be used to get the most specific parameter value for a given key. {{< gh 1462 >}} * Several new information elements have been added to `Page` and `Node`: * `RuneCount`: The number of [runes](http://blog.golang.org/strings) in the content, excluding any whitespace. This may be a good alternative to `.WordCount` for Japanese and other CJK languages where a word-split by spaces makes no sense. {{< gh 1266 >}} * `RawContent`: Raw Markdown as a string. One use case may be of embedding remarkjs.com slides. * `IsHome`: tells the truth about whether you're on the home page or not. ### Improvements * `hugo server` now builds ~30%+ faster by rendering to memory instead of disk. To get the old behavior, start the server with `--renderToDisk=true`. * Hugo now supports dynamic reloading of the config file when watching. * We now use a custom-built `LazyFileReader` for reading file contents, which means we don't read media files in `/content` into memory anymore -- and file reading is now performed in parallel on multicore PCs. {{< gh 1181 >}} * Hugo is now built with `Go 1.5` which, among many other improvements, have fixed the last known data race in Hugo. {{< gh 917 >}} * Paginator now also supports page groups. {{< gh 1274 >}} * Markdown improvements: * Hugo now supports GitHub-flavoured markdown code fences for highlighting for `md`-files (Blackfriday rendered markdown) and `mmark` files (MMark rendered markdown). {{< gh 362 1258 >}} * Several new Blackfriday options are added: * Option to disable Blackfriday's `Smartypants`. * Option for Blackfriday to open links in a new window/tab. {{< gh 1220 >}} * Option to disable Blackfriday's LaTeX style dashes {{< gh 1231 >}} * Definition lists extension support. * `Scratch` now has built-in `map` support. * We now fall back to `link title` for the default page sort. {{< gh 1299 >}} * Some notable new configuration options: * `IgnoreFiles` can be set with a list of Regular Expressions that matches files to be ignored during build. {{< gh 1189 >}} * `PreserveTaxonomyNames`, when set to `true`, will preserve what you type as the taxonomy name both in the folders created and the taxonomy `key`, but it will be normalized for the URL. {{< gh 1180 >}} * `hugo gen` can now generate man files, bash auto complete and markdown documentation * Hugo will now make suggestions when a command is mistyped * Shortcodes now have a boolean `.IsNamedParams` property. {{< gh 1597 >}} ### New Template Features * All template engines: * The new `dict` function that could be used to pass maps into a template. {{< gh 1463 >}} * The new `pluralize` and `singularize` template funcs. * The new `base64Decode` and `base64Encode` template funcs. * The `sort` template func now accepts field/key chaining arguments and pointer values. {{< gh 1330 >}} * Several fixes for `slicestr` and `substr`, most importantly, they now have full `utf-8`-support. {{< gh 1190 1333 1347 >}} * The new `last` template function allows the user to select the last `N` items of a slice. {{< gh 1148 >}} * The new `after` func allows the user to select the items after the `Nth` item. {{< gh 1200 >}} * Add `time.Time` type support to the `where`, `ge`, `gt`, `le`, and `lt` template functions. * It is now possible to use constructs like `where Values ".Param.key" nil` to filter pages that doesn't have a particular parameter. {{< gh 1232 >}} * `getJSON`/`getCSV`: Add retry on invalid content. {{< gh 1166 >}} * The new `readDir` func lists local files. {{< gh 1204 >}} * The new `safeJS` function allows the embedding of content into JavaScript contexts in Go templates. * Get the main site RSS link from any page by accessing the `.Site.RSSLink` property. {{< gh 1566 >}} * Ace templates: * Base templates now also works in themes. {{< gh 1215 >}}. * And now also on Windows. {{< gh 1178 >}} * Full support for Amber templates including all template functions. * A built-in template for Google Analytics. {{< gh 1505 >}} * Hugo is now shipped with new built-in shortcodes: {{< gh 1576 >}} * `youtube` for YouTube videos * `vimeo` for Vimeo videos * `gist` for GitHub gists * `tweet` for Twitter Tweets * `speakerdeck` for Speakerdeck slides ### Bugfixes * Fix data races in page sorting and page reversal. These operations are now also cached. {{< gh 1293 >}} * `page.HasMenuCurrent()` and `node.HasMenuCurrent()` now work correctly in multi-level nested menus. * Support `Fish and Chips` style section titles. Previously, this would end up as `Fish And Chips`. Now, the first character is made toupper, but the rest are preserved as-is. {{< gh 1176 >}} * Hugo now removes superfluous p-tags around shortcodes. {{< gh 1148 >}} ### Notices * `hugo server` will watch by default now. * Some fields and methods were deprecated in `0.14`. These are now removed, so the error message isn't as friendly if you still use the old values. So please change: * `getJson` to `getJSON`, `getCsv` to `getCSV`, `safeHtml` to `safeHTML`, `safeCss` to `safeCSS`, `safeUrl` to `safeURL`, `Url` to `URL`, `UrlPath` to `URLPath`, `BaseUrl` to `BaseURL`, `Recent` to `Pages`. ### Known Issues Using the Hugo v0.15 32-bit Windows or ARM binary, running `hugo server` would crash or hang due to a [memory alignment issue](https://golang.org/pkg/sync/atomic/#pkg-note-BUG) in [Afero](https://github.com/spf13/afero). The bug was discovered shortly after the v0.15.0 release and has since been [fixed](https://github.com/spf13/afero/pull/23) by {{< gh "@tpng" >}}. If you encounter this bug, you may either compile Hugo v0.16-DEV from source, or use the following solution/workaround: * **64-bit Windows users: Please use [hugo_0.15_windows_amd64.zip](https://github.com/spf13/hugo/releases/download/v0.15/hugo_0.15_windows_amd64.zip)** (amd64 == x86-64). It is only the 32-bit hugo_0.15_windows_386.zip that crashes/hangs (see {{< gh 1621 >}} and {{< gh 1628 >}}). * **32-bit Windows and ARM users: Please run `hugo server --renderToDisk` as a workaround** until Hugo v0.16 is released (see [“hugo server” returns runtime error on armhf](https://discuss.gohugo.io/t/hugo-server-returns-runtime-error-on-armhf/2293) and {{< gh 1716 >}}). ---- ## **0.14.0** May 25, 2015 The v0.14.0 Hugo release brings of the most demanded features to Hugo. The foundation of Hugo is stabilizing nicely and a lot of polish has been added. We’ve expanded support for additional content types with support for AsciiDoc, Restructured Text, HTML and Markdown. Some of these types depend on external libraries as there does not currently exist native support in Go. We’ve tried to make the experience as seamless as possible. Look for more improvements here in upcoming releases. A lot of work has been done to improve the user experience, with extra polish to the Windows experience. Hugo errors are more helpful overall and Hugo now can detect if it’s being run in Windows Explorer and provide additional instructions to run it via the command prompt. The Hugo community continues to grow. Hugo has over 4000 stars on github, 165 contributors, 35 themes and 1000s of happy users. It is now the 5th most popular static site generator (by Stars) and has the 3rd largest contributor community. This release represents over **240 contributions by 36 contributors** to the main Hugo codebase. Big shout out to {{< gh "@bep" >}} who led the development of Hugo this release, {{< gh "@anthonyfok" >}}, {{< gh "@eparis" >}}, {{< gh "@SchumacherFM" >}}, {{< gh "@RickCogley" >}} & {{< gh "@mdhender" >}} for their significant contributions and {{< gh "@tatsushid" >}} for his continuous improvements to the templates. Also a big thanks to all the theme creators. 11 new themes have been added since last release and the [hugoThemes repo now has previews of all of them](https://github.com/spf13/hugoThemes/blob/master/README.md#theme-list). Hugo also depends on a lot of other great projects. A big thanks to all of our dependencies including: [cobra](https://github.com/spf13/cobra), [viper](https://github.com/spf13/viper), [blackfriday](https://github.com/russross/blackfriday), [pflag](https://github.com/spf13/pflag), [HugoThemes](https://github.com/spf13/hugothemes), [BurntSushi](https://github.com/BurntSushi/toml), [goYaml](https://github.com/go-yaml/yaml/tree/v2), and the Go standard library. ## New features * Support for all file types in content directory. * If dedicated file type handler isn’t found it will be copied to the destination. * Add `AsciiDoc` support using external helpers. * Add experimental support for [`Mmark`](https://github.com/miekg/mmark) markdown processor * Bash autocomplete support via `genautocomplete` command * Add section menu support for a [Section Menu for "the Lazy Blogger"]({{< relref "extras/menus.md#section-menu-for-the-lazy-blogger" >}}) * Add support for `Ace` base templates * Adding `RelativeURLs = true` to site config will now make all the relative URLs relative to the content root. * New template functions: * `getenv` * The string functions `substr` and `slicestr` * `seq`, a sequence generator very similar to its Gnu counterpart * `absURL` and `relURL`, both of which takes the `BaseURL` setting into account ## Improvements * Highlighting with `Pygments` is now cached to disk -- expect a major speed boost if you use it! * More Pygments highlighting options, including `line numbers` * Show help information to Windows users who try to double click on `hugo.exe`. * Add `bind` flag to `hugo server` to set the interface to which the server will bind * Add support for `canonifyURLs` in `srcset` * Add shortcode support for HTML (content) files * Allow the same `shortcode` to be used with or without inline content * Configurable RSS output filename ## Bugfixes * Fix panic with paginator and zero pages in result set. * Fix crossrefs on Windows. * Fix `eq` and `ne` template functions when used with a raw number combined with the result of `add`, `sub` etc. * Fix paginator with uglyURLs * Fix {{< gh 998 >}}, supporting UTF8 characters in Permalinks. ## Notices * To get variable and function names in line with the rest of the Go community, a set of variable and function names has been deprecated: These will still work in 0.14, but will be removed in 0.15. What to do should be obvious by the build log; `getJson` to `getJSON`, `getCsv` to `getCSV`, `safeHtml` to `safeHTML`, `safeCss` to `safeCSS`, `safeUrl` to `safeURL`, `Url` to `URL`, `UrlPath` to `URLPath`, `BaseUrl` to `BaseURL`, `Recent` to `Pages`, `Indexes` to `Taxonomies`. ---- ## **0.13.0** Feb 21, 2015 The v0.13.0 release is the largest Hugo release to date. The release introduced some long sought after features (pagination, sequencing, data loading, tons of template improvements) as well as major internal improvements. In addition to the code changes, the Hugo community has grown significantly and now has over 3000 stars on github, 134 contributors, 24 themes and 1000s of happy users. This release represents **448 contributions by 65 contributors** A special shout out to {{< gh "@bep" >}} and {{< gh "@anthonyfok" >}} for their new role as Hugo maintainers and their tremendous contributions this release. ### New major features * Support for [data files](/extras/datafiles/) in [YAML](http://yaml.org/), [JSON](http://www.json.org/), or [TOML](https://github.com/toml-lang/toml) located in the `data` directory ({{< gh 885 >}}) * Support for [dynamic content](/extras/dynamiccontent/) by loading JSON & CSV from remote sources via GetJson and GetCsv in short codes or other layout files ({{< gh 748 >}}) * [Pagination support](/extras/pagination/) for home page, sections and taxonomies ({{< gh 750 >}}) * Universal sequencing support * A new, generic Next/Prev functionality is added to all lists of pages (sections, taxonomies, etc.) * Add in-section [Next/Prev](/templates/variables/) content pointers * `Scratch` -- [a "scratchpad"](/extras/scratch) for your node- and page-scoped variables * [Cross Reference](/extras/crossreferences/) support to easily link documents together with the ref and relref shortcodes. * [Ace](http://ace.yoss.si/) template engine support ({{< gh 541 >}}) * A new [shortcode](/extras/shortcodes/) token of `{{}}` (raw HTML) alongside the existing `{{%/* */%}}` (Markdown) * A top level `Hugo` variable (on Page & Node) is added with various build information * Several new ways to order and group content: * `ByPublishDate` * `GroupByPublishDate(format, order)` * `GroupByParam(key, order)` * `GroupByParamDate(key, format, order)` * Hugo has undergone a major refactoring, with a new handler system and a generic file system. This sounds and is technical, but will pave the way for new features and make Hugo even speedier ### Notable enhancements to existing features * The [shortcode](/extras/shortcodes/) handling is rewritten for speed and better error messages. * Several improvements to the [template functions](/templates/functions/): * `where` is now even more powerful and accepts SQL-like syntax with the operators `==`, `eq`; `!=`, `<>`, `ne`; `>=`, `ge`; `>`, `gt`; `<=`, `le`; `<`, `lt`; `in`, `not in` * `where` template function now also accepts dot chaining key argument (e.g. `"Params.foo.bar"`) * New template functions: * `apply` * `chomp` * `delimit` * `sort` * `markdownify` * `in` and `intersect` * `trim` * `replace` * `dateFormat` * Several [configurable improvements related to Markdown rendering](/overview/configuration/#configure-blackfriday-rendering:a66b35d20295cb764719ac8bd35837ec): * Configuration of footnote rendering * Optional support for smart angled quotes, e.g. `"Hugo"` → «Hugo» * Enable descriptive header IDs * URLs in XML output is now correctly canonified ({{< gh 725 728 >}}, and part of {{< gh 789 >}}) ### Other improvements * Internal change to use byte buffer pool significantly lowering memory usage and providing measurable performance improvements overall * Changes to docs: * A new [Troubleshooting](/troubleshooting/overview/) section is added * It's now searchable through Google Custom Search ({{< gh 753 >}}) * Some new great tutorials: * [Automated deployments with Wercker](/tutorials/automated-deployments/) * [Creating a new theme](/tutorials/creating-a-new-theme/) * [`hugo new`](/content/archetypes/) now copies the content in addition to the front matter * Improved unit test coverage * Fixed a lot of Windows-related path issues * Improved error messages for template and rendering errors * Enabled soft LiveReload of CSS and images ({{< gh 490 >}}) * Various fixes in RSS feed generation ({{< gh 789 >}}) * `HasMenuCurrent` and `IsMenuCurrent` is now supported on Nodes * A bunch of [bug fixes](https://github.com/spf13/hugo/commits/master) ---- ## **0.12.0** Sept 1, 2014 A lot has happened since Hugo v0.11.0 was released. Most of the work has been focused on polishing the theme engine and adding critical functionality to the templates. This release represents over 90 code commits from 28 different contributors. * 10 [new themes](https://github.com/spf13/hugoThemes) created by the community * Fully themable [Partials](/templates/partials/) * [404 template](/templates/404/) support in themes * [Shortcode](/extras/shortcodes/) support in themes * [Views](/templates/views/) support in themes * Inner [shortcode](/extras/shortcodes/) content now treated as Markdown * Support for header ids in Markdown (# Header {#myid}) * [Where](/templates/list/) template function to filter lists of content, taxonomies, etc. * [GroupBy](/templates/list/) & [GroupByDate](/templates/list/) methods to group pages * Taxonomy [pages list](/taxonomies/methods/) now sortable, filterable, limitable & groupable * General cleanup to taxonomies & documentation to make it more clear and consistent * [Showcase](/showcase/) returned and has been expanded * Pretty links now always have trailing slashes * [BaseUrl](/overview/configuration/) can now include a subdirectory * Better feedback about draft & future post rendering * A variety of improvements to [the website](http://gohugo.io/) ---- ## **0.11.0** May 28, 2014 This release represents over 110 code commits from 29 different contributors. * Considerably faster... about 3 - 4x faster on average * [LiveReload](/extras/livereload/). Hugo will automatically reload the browser when the build is complete * Theme engine w/[Theme Repository](https://github.com/spf13/hugoThemes) * [Menu system](/extras/menus/) with support for active page * [Builders](/extras/builders/) to quickly create a new site, content or theme * [XML sitemap](/templates/sitemap/) generation * [Integrated Disqus](/extras/comments/) support * Streamlined [template organization](/templates/overview/) * [Brand new docs site](http://gohugo.io/) * Support for publishDate which allows for posts to be dated in the future * More [sort](/content/ordering/) options * Logging support * Much better error handling * More informative verbose output * Renamed Indexes > [Taxonomies](/taxonomies/overview/) * Renamed Chrome > [Partials](/templates/partials/) ---- ## **0.10.0** March 1, 2014 This release represents over 110 code commits from 29 different contributors. * [Syntax highlighting](/extras/highlighting/) powered by pygments (**slow**) * Ability to [sort content](/content/ordering/) many more ways * Automatic [table of contents](/extras/toc/) generation * Support for Unicode URLs, aliases and indexes * Configurable per-section [permalink](/extras/permalinks/) pattern support * Support for [paired shortcodes](/extras/shortcodes/) * Shipping with some [shortcodes](/extras/shortcodes/) (highlight & figure) * Adding [canonify](/extras/urls/) option to keep urls relative * A bunch of [additional template functions](/layout/functions/) * Watching very large sites now works on Mac * RSS generation improved. Limited to 50 items by default, can limit further in [template](/layout/rss/) * Boolean params now supported in [frontmatter](/content/front-matter/) * Launched website [showcase](/showcase/). Show off your own hugo site! * A bunch of [bug fixes](https://github.com/spf13/hugo/commits/master) ---- ## **0.9.0** November 15, 2013 This release represents over 220 code commits from 22 different contributors. * New [command based interface](/overview/usage/) similar to git (`hugo server -s ./`) * Amber template support * [Aliases](/extras/aliases/) (redirects) * Support for top level pages (in addition to homepage) * Complete overhaul of the documentation site * Full Windows support * Better index support including [ordering by content weight](/content/ordering/) * Add params to site config, available in .Site.Params from templates * Friendlier json support * Support for html & xml content (with frontmatter support) * Support for [summary](/content/summaries/) content divider (<!--more-->) * HTML in [summary](/content/summaries/) (when using divider) * Added ["Minutes to Read"](/layout/variables/) functionality * Support for a custom 404 page * Cleanup of how content organization is handled * Loads of unit and performance tests * Integration with travis ci * Static directory now watched and copied on any addition or modification * Support for relative permalinks * Fixed watching being triggered multiple times for the same event * Watch now ignores temp files (as created by Vim) * Configurable number of posts on [homepage](/layout/homepage/) * [Front matter](/content/front-matter/) supports multiple types (int, string, date, float) * Indexes can now use a default template * Addition of truncated bool to content to determine if should show 'more' link * Support for [linkTitles](/layout/variables/) * Better handling of most errors with directions on how to resolve * Support for more date / time formats * Support for go 1.2 * Support for `first` in templates ---- ## **0.8.0** August 2, 2013 This release represents over 65 code commits from 6 different contributors. * Added support for pretty urls (filename/index.html vs filename.html) * Hugo supports a destination directory * Will efficiently sync content in static to destination directory * Cleaned up options.. now with support for short and long options * Added support for TOML * Added support for YAML * Added support for Previous & Next * Added support for indexes for the indexes * Better Windows compatibility * Support for series * Adding verbose output * Loads of bugfixes ---- ## **0.7.0** July 4, 2013 * Hugo now includes a simple server * First public release ---- ## **0.6.0** July 2, 2013 * Hugo includes an example documentation site which it builds ---- ## **0.5.0** June 25, 2013 * Hugo is quite usable and able to build spf13.com hugo-0.18.1/docs/content/meta/roadmap.md000066400000000000000000000035131303124201100200250ustar00rootroot00000000000000--- aliases: - /doc/roadmap/ - /meta/roadmap/ lastmod: 2015-02-16 date: 2013-07-01 menu: main: parent: about notoc: true title: Hugo Roadmap weight: 20 --- In no particular order, here is what we are working on: * Intelligently related posts ([#98][]) * Even easier deployment to S3, SSH, GitHub, rsync. Give the [tools section](https://gohugo.io/tools/#deployment) a shot or read one of the related tutorials. * Import from other website systems. There are already existing [migration tools](https://gohugo.io/tools/#migration) but they don't cover all major platforms. * An interactive web based editor (See https://discuss.gohugo.io/t/web-based-editor/155) * Additional [themes](https://github.com/spf13/hugoThemes) (always on-going, contributions welcome!) * Dynamic image resizing via shortcodes ([#1014][]) * Native support for additional content formats (AsciiDoc [#1435][], reST [#1436][]) * And, last but not least, ***Your best ideas***! [#100]: https://github.com/spf13/hugo/issues/100 "hugo import from wordpress · Issue #100 · spf13/hugo" [#101]: https://github.com/spf13/hugo/issues/101 "hugo import from jekyll · Issue #101 · spf13/hugo" [#1435]: https://github.com/spf13/hugo/issues/1435 "Add support for native Go implementation of AsciiDoc · Issue #1435 · spf13/hugo" [#1436]: https://github.com/spf13/hugo/issues/1436 "Add support for native Go implementation of reStructuredText (reST) · Issue #1436 · spf13/hugo" [#1014]: https://github.com/spf13/hugo/issues/1014 "Image Resizing and Cropping · Issue #1014 · spf13/hugo" [#98]: https://github.com/spf13/hugo/issues/98 "Add support for related content · Issue #98 · spf13/hugo" > Feel free to [contribute]({{< relref "tutorials/how-to-contribute-to-hugo.md" >}}) or open a [new issue](https://github.com/spf13/hugo/issues/new) if you have an idea for a new feature.) hugo-0.18.1/docs/content/overview/000077500000000000000000000000001303124201100167765ustar00rootroot00000000000000hugo-0.18.1/docs/content/overview/configuration.md000066400000000000000000000454331303124201100222000ustar00rootroot00000000000000--- aliases: - /doc/configuration/ lastmod: 2016-09-17 date: 2013-07-01 linktitle: Configuration menu: main: parent: getting started next: /overview/source-directory toc: true prev: /overview/usage title: Configuring Hugo weight: 40 --- The directory structure of a Hugo web site—or more precisely, of the source files containing its content and templates—provide most of the configuration information that Hugo needs. Therefore, in essence, many web sites wouldn't actually need a configuration file. This is because Hugo is designed to recognize certain typical usage patterns (and it expects them, by default). Nevertheless, Hugo does search for a configuration file bearing a particular name in the root of your web site's source directory. First, it looks for a `./config.toml` file. If that's not present, it will seek a `./config.yaml` file, followed by a `./config.json` file. In this `config` file for your web site, you can include precise directions to Hugo regarding how it should render your site, as well as define its menus, and set various other site-wide parameters. Another way that web site configuration can be accomplished is through operating system environment variables. For instance, the following command will work on Unix-like systems—it sets a web site's title: ```bash $ env HUGO_TITLE="Some Title" hugo ``` (**Note:** all such environment variable names must be prefixed with HUGO_.) ## Examples Following is a typical example of a YAML configuration file. Three periods end the document: ```yaml --- baseURL: "http://yoursite.example.com/" ... ``` Following is an example TOML configuration file with some default values. The values under `[params]` will populate the `.Site.Params` variable for use in templates: ```toml contentDir = "content" layoutDir = "layouts" publishDir = "public" buildDrafts = false baseURL = "http://yoursite.example.com/" canonifyURLs = true [taxonomies] category = "categories" tag = "tags" [params] description = "Tesla's Awesome Hugo Site" author = "Nikola Tesla" ``` Here is a YAML configuration file which sets a few more options: ```yaml --- baseURL: "http://yoursite.example.com/" title: "Yoyodyne Widget Blogging" footnoteReturnLinkContents: "↩" permalinks: post: /:year/:month/:title/ params: Subtitle: "Spinning the cogs in the widgets" AuthorName: "John Doe" GitHubUser: "spf13" ListOfFoo: - "foo1" - "foo2" SidebarRecentLimit: 5 ... ``` ## Configuration variables Following is a list of Hugo-defined variables you can configure, along with their current, default values: --- archetypeDir: "archetypes" # hostname (and path) to the root, e.g. http://spf13.com/ baseURL: "" # include content marked as draft buildDrafts: false # include content with publishdate in the future buildFuture: false # include content already expired buildExpired: false # enable this to make all relative URLs relative to content root. Note that this does not affect absolute URLs. relativeURLs: false canonifyURLs: false # config file (default is path/config.yaml|json|toml) config: "config.toml" contentDir: "content" dataDir: "data" defaultExtension: "html" defaultLayout: "post" # Missing translations will default to this content language defaultContentLanguage: "en" # Renders the default content language in subdir, e.g. /en/. The root directory / will redirect to /en/ defaultContentLanguageInSubdir: false disableLiveReload: false # Do not build RSS files disableRSS: false # Do not build Sitemap file disableSitemap: false # Enable GitInfo feature enableGitInfo: false # Build robots.txt file enableRobotsTXT: false # Do not render 404 page disable404: false # Do not inject generator meta tag on homepage disableHugoGeneratorInject: false # edit new content with this editor, if provided editor: "" # Enable Emoji emoticons support for page content. # See www.emoji-cheat-sheet.com enableEmoji: false # Show a placeholder instead of the default value or an empty string if a translation is missing enableMissingTranslationPlaceholders: false footnoteAnchorPrefix: "" footnoteReturnLinkContents: "" # google analytics tracking id googleAnalytics: "" languageCode: "" layoutDir: "layouts" # Enable Logging log: false # Log File path (if set, logging enabled automatically) logFile: "" # "yaml", "toml", "json" metaDataFormat: "toml" newContentEditor: "" # Don't sync permission mode of files noChmod: false # Don't sync modification time of files noTimes: false paginate: 10 paginatePath: "page" permalinks: # Pluralize titles in lists using inflect pluralizeListTitles: true # Preserve special characters in taxonomy names ("Gérard Depardieu" vs "Gerard Depardieu") preserveTaxonomyNames: false # filesystem path to write files to publishDir: "public" # enables syntax guessing for code fences without specified language pygmentsCodeFencesGuessSyntax: false # color-codes for highlighting derived from this style pygmentsStyle: "monokai" # true: use pygments-css or false: color-codes directly pygmentsUseClasses: false # default sitemap configuration map sitemap: # filesystem path to read files relative from source: "" staticDir: "static" # display memory and timing of different steps of the program stepAnalysis: false # theme to use (located by default in /themes/THEMENAME/) themesDir: "themes" theme: "" title: "" # if true, use /filename.html instead of /filename/ uglyURLs: false # Do not make the url/path to lowercase disablePathToLower: false # if true, auto-detect Chinese/Japanese/Korean Languages in the content. (.Summary and .WordCount can work properly in CJKLanguage) hasCJKLanguage: false # verbose output verbose: false # verbose logging verboseLog: false # watch filesystem for changes and recreate as needed watch: true --- ## Ignore various files when rendering The following statement inside `./config.toml` will cause Hugo to ignore files ending with `.foo` and `.boo` when rendering: ```toml ignoreFiles = [ "\\.foo$", "\\.boo$" ] ``` The above is a list of regular expressions. Note that the backslash (`\`) character is escaped, to keep TOML happy. ## Configure Blackfriday rendering [Blackfriday](https://github.com/russross/blackfriday) is Hugo's [Markdown](http://daringfireball.net/projects/markdown/) rendering engine. In the main, Hugo typically configures Blackfriday with a sane set of defaults. These defaults should fit most use cases, reasonably well. However, if you have unusual needs with respect to Markdown, Hugo exposes some of its Blackfriday behavior options for you to alter. The following table lists these Hugo options, paired with the corresponding flags from Blackfriday's source code (for the latter, see [html.go](https://github.com/russross/blackfriday/blob/master/html.go) and [markdown.go](https://github.com/russross/blackfriday/blob/master/markdown.go)):
Flag Default Blackfriday flag
taskLists true
Purpose: false turns off GitHub-style automatic task/TODO list generation.
smartypants true HTML_USE_SMARTYPANTS
Purpose: false disables smart punctuation substitutions including smart quotes, smart dashes, smart fractions, etc. If true, it may be fine-tuned with the angledQuotes, fractions, smartDashes and latexDashes flags (see below).
angledQuotes false HTML_SMARTYPANTS_ANGLED_QUOTES
Purpose: true enables smart, angled double quotes.
Example: "Hugo" renders to «Hugo» instead of “Hugo”.
fractions true HTML_SMARTYPANTS_FRACTIONS
Purpose: false disables smart fractions.
Example: 5/12 renders to 5⁄12 (<sup>5</sup>&frasl;<sub>12</sub>).
Caveat: Even with fractions = false, Blackfriday still converts 1/2, 1/4 and 3/4 respectively to ½ (&frac12;), ¼ (&frac14;) and ¾ (&frac34;), but only these three.
smartDashes true HTML_SMARTYPANTS_DASHES
Purpose: false disables smart dashes; i.e., the conversion of multiple hyphens into en dash or em dash. If true, its behavior can be modified with the latexDashes flag below.
latexDashes true HTML_SMARTYPANTS_LATEX_DASHES
Purpose: false disables LaTeX-style smart dashes and selects conventional smart dashes. Assuming smartDashes (above), if this is:
  • true, then -- is translated into “–” (&ndash;), whereas --- is translated into “—” (&mdash;).
  • false, then -- is translated into “—” (&mdash;), whereas a spaced single hyphen between two words is translated into an en dash—e.g., 12 June - 3 July becomes 12 June &ndash; 3 July.
hrefTargetBlank false HTML_HREF_TARGET_BLANK
Purpose: true opens external links in a new window or tab.
plainIDAnchors true FootnoteAnchorPrefix and HeaderIDSuffix
Purpose: true renders any header and footnote IDs without the document ID.
Example: renders #my-header instead of #my-header:bec3ed8ba720b9073ab75abcf3ba5d97.
extensions [] EXTENSION_*
Purpose: Enable one or more of Blackfriday's Markdown extensions (if they aren't Hugo defaults).
Example:   Include "hardLineBreak" in the list to enable Blackfriday's EXTENSION_HARD_LINE_BREAK.
extensionsmask [] EXTENSION_*
Purpose: Disable one or more of Blackfriday's Markdown extensions (if they are Hugo defaults).
Example:   Include "autoHeaderIds" in the list to disable Blackfriday's EXTENSION_AUTO_HEADER_IDS.
sourceRelativeLinksEval false none
Purpose: true enables source file-based relative linking (à la Github). Relative links to Markdown and static files within a page will be evaluated relative to the location of that page, and then converted to HTML links during rendering.
Example: [some-reference-text](../other/page.md) in ./content/total/overview.md will link to ./content/other/overview.md and render to /other/overview/ in the HTML output.
sourceRelativeLinksProjectFolder /docs/content none
Purpose: Set a sub-folder for source file-based relative linking on a Hugo Project (i.e., a web site). When sourceRelativeLinksEval (see above) is enabled, some source level paths may contain absolute respository paths to Markdown or static files. The absolute portion of these paths should be removed before trying to match the intended links.
Example: Assuming your documentation resides in ./docs/content, then a reference within ./docs/content/total/overview.md to [some-reference-text](/docs/content/other/page.md) will link to ./docs/content/other/overview.md and render to /other/overview/ in the HTML output.
**Notes** * These flags are **case sensitive** (as of Hugo v0.15)! * These flags must be grouped under the `blackfriday` key and can be set on **both the site level and the page level**. Any setting on a page will override the site setting there. For example:
TOML YAML 
[blackfriday]
  angledQuotes = true
  fractions = false
  plainIDAnchors = true
  extensions = ["hardLineBreak"]

blackfriday:
  angledQuotes: true
  fractions: false
  plainIDAnchors: true
  extensions:
    - hardLineBreak
hugo-0.18.1/docs/content/overview/installing.md000066400000000000000000000056531303124201100214750ustar00rootroot00000000000000 --- aliases: - /doc/installing/ lastmod: 2016-01-04 date: 2013-07-01 menu: main: parent: getting started next: /overview/usage prev: /overview/quickstart title: Installing Hugo weight: 20 --- Hugo is written in [Go][] with support for multiple platforms. The latest release can be found at [Hugo Releases](https://github.com/spf13/hugo/releases). We currently provide pre-built binaries for  Windows,  Linux,  FreeBSD and  OS X (Darwin) 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. See http://golang.org/doc/install/source for the full set of supported combinations of target operating systems and compilation architectures. ## Installing Hugo (binary) Installation is very easy. Simply download the appropriate version for your platform from [Hugo Releases](https://github.com/spf13/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. On OS X, if you have [Homebrew](http://brew.sh/), installation is even easier: just run `brew update && brew install hugo`. For a more detailed explanation follow the corresponding installation guides: - [Installation on OS X]({{< relref "tutorials/installing-on-mac.md" >}}) - [Installation on Windows]({{< relref "tutorials/installing-on-windows.md" >}}) ### Installing Pygments (optional) The Hugo executable has one *optional* external dependency for source code highlighting (Pygments). If you want to have source code highlighting using the [highlight shortcode](/extras/highlighting/), you need to install the Python-based Pygments program. The procedure is outlined on the [Pygments home page](http://pygments.org/). ## Upgrading Hugo Upgrading Hugo is as easy as downloading and replacing the executable you’ve placed in your `PATH`. ## Installing from source ### Prerequisite tools for downloading and building source code * [Git](http://git-scm.com/) * [Go][] 1.5+ ### Get directly from GitHub $ export GOPATH=$HOME/go $ go get -v github.com/spf13/hugo `go get` will then fetch Hugo and all its dependent libraries to your `$GOPATH/src` directory, and compile everything into the final `hugo` (or `hugo.exe`) executable, which you will find sitting in the `$GOPATH/bin/` directory, all ready to go! You may run `go get` with the `-u` option to update Hugo's dependencies: $ go get -u -v github.com/spf13/hugo ## Contributing Please see the [contributing guide](/doc/contributing/). [Go]: http://golang.org/ hugo-0.18.1/docs/content/overview/introduction.md000066400000000000000000000205071303124201100220450ustar00rootroot00000000000000--- lastmod: 2016-08-14 date: 2013-07-01 linktitle: Introduction menu: main: parent: getting started next: /overview/quickstart title: Introduction to Hugo weight: 5 --- ## What is Hugo? Hugo is a general-purpose website framework. Technically speaking, Hugo is a static site generator. Unlike other systems which dynamically build a page every time a visitor requests one, Hugo does the building when you create your content. Since websites are viewed far more often than they are edited, Hugo is optimized for website viewing while providing a great writing experience. Sites built with Hugo are extremely fast and very secure. Hugo sites can be hosted anywhere, including [Heroku][], [GoDaddy][], [DreamHost][], [GitHub Pages][], [Surge][], [Aerobatic][], [Firebase Hosting][], [Google Cloud Storage][], [Amazon S3][] and [CloudFront][], and work well with CDNs. Hugo sites run without dependencies on expensive runtimes like Ruby, Python or PHP and without dependencies on any databases. [Heroku]: https://www.heroku.com/ [GoDaddy]: https://www.godaddy.com/ [DreamHost]: http://www.dreamhost.com/ [GitLab]: https://about.gitlab.com [GitHub Pages]: https://pages.github.com/ [Aerobatic]: https://www.aerobatic.com/ [Firebase Hosting]: https://firebase.google.com/docs/hosting/ [Google Cloud Storage]: http://cloud.google.com/storage/ [Amazon S3]: http://aws.amazon.com/s3/ [CloudFront]: http://aws.amazon.com/cloudfront/ "Amazon CloudFront" [Surge]: https://surge.sh We think of Hugo as the ideal website creation tool. With nearly instant build times and the ability to rebuild whenever a change is made, Hugo provides a very fast feedback loop. This is essential when you are designing websites, but also very useful when creating content. ## What makes Hugo different? Web site generators render content into HTML files. Most are "dynamic site generators." That means the HTTP server (which is the program running on your website that the user's browser talks to) runs the generator to create a new HTML file each and every time a user wants to view a page. Creating the page dynamically means that the computer hosting the HTTP server has to have enough memory and CPU to effectively run the generator around the clock. If not, then the user has to wait in a queue for the page to be generated. Nobody wants users to wait longer than needed, so the dynamic site generators programmed their systems to cache the HTML files. When a file is cached, a copy of it is temporarily stored on the computer. It is much faster for the HTTP server to send that copy the next time the page is requested than it is to generate it from scratch. Hugo takes caching a step further. All HTML files are rendered on your computer. You can review the files before you copy them to the computer hosting the HTTP server. Since the HTML files aren't generated dynamically, we say that Hugo is a "static site generator." Not running a web site generator on your HTTP server has many benefits. The most noticeable is performance - HTTP servers are very good at sending files. So good that you can effectively serve the same number of pages with a fraction of the memory and CPU needed for a dynamic site. Hugo has two components to help you build and test your web site. The one that you'll probably use most often is the built-in HTTP server. When you run `hugo server`, Hugo renders all of your content into HTML files and then runs an HTTP server on your computer so that you can see what the pages look like. The second component is used when you're ready to publish your web site to the computer running your website. Running Hugo without any actions will rebuild your entire web site using the `baseURL` setting from your site's configuration file. That's required to have your page links work properly with most hosting companies. ## How fast is Hugo? {{% youtube CdiDYZ51a2o %}} ## What does Hugo do? In technical terms, Hugo takes a source directory of files and templates and uses these as input to create a complete website. Hugo boasts the following features: ### General * Extremely fast build times (~1 ms per page) * Completely cross platform: Runs on  Mac OS X,  Linux,  Windows, and more! * Easy [installation](/overview/installing/) * Render changes [on the fly](/overview/usage/) with [LiveReload](/extras/livereload/) as you develop * Complete theme support * Host your site anywhere ### Organization * Straightforward [organization](/content/organization/) * Support for [website sections](/content/sections/) * Completely customizable [URLs](/extras/urls/) * Support for configurable [taxonomies](/taxonomies/overview/) which includes categories and tags. Create your own custom organization of content * Ability to [sort content](/content/ordering/) as you desire * Automatic [table of contents](/extras/toc/) generation * Dynamic menu creation * [Pretty URLs](/extras/urls/) support * [Permalink](/extras/permalinks/) pattern support * [Aliases](/extras/aliases/) (redirects) ### Content * Native support for content written in [Markdown](/content/example/) * Support for other languages through _external helpers_, see [supported formats](/content/supported-formats) * Support for TOML, YAML and JSON metadata in [frontmatter](/content/front-matter/) * Completely [customizable homepage](/layout/homepage/) * Support for multiple [content types](/content/types/) * Automatic and user defined [summaries](/content/summaries/) * [Shortcodes](/extras/shortcodes/) to enable rich content inside of Markdown * ["Minutes to Read"](/layout/variables/) functionality * ["Wordcount"](/layout/variables/) functionality ### Additional Features * Integrated [Disqus](https://disqus.com/) comment support * Integrated [Google Analytics](https://google-analytics.com/) support * Automatic [RSS](/layout/rss/) creation * Support for [Go](http://golang.org/pkg/html/template/), [Amber](https://github.com/eknkc/amber) and [Ace](https://github.com/yosssi/ace) HTML templates * Syntax [highlighting](/extras/highlighting/) powered by [Pygments](http://pygments.org/) See what's coming next in the [roadmap](/meta/roadmap/). ## Who should use Hugo? Hugo is for people that prefer writing in a text editor over a browser. Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases. Hugo is for people building a blog, company site, portfolio, tumblog, documentation, single page site or a site with thousands of pages. ## Why did you write Hugo? I wrote Hugo ultimately for a few reasons. First, I was disappointed with WordPress, my then website solution. With it, I couldn't create content as efficiently as I wanted to. It rendered slowly. It required me to be online to write posts: plus its constant security updates and the horror stories of people's hacked blogs! I hated how content for it was written only in HTML, instead of the much simpler Markdown. Overall, I felt like WordPress got in my way much more than it helped me. It kept me from writing great content. I looked at the existing static site generators like [Jekyll][], [Middleman][] and [Nanoc][]. All had complicated installation dependencies and took far longer to render my blog with its hundreds of posts than I felt was acceptable. I wanted a framework to be able to give me rapid feedback while making changes to the templates, and the 5+-minute render times were just too slow. In general, they were also very blog minded and didn't have the ability to provide other content types and flexible URLs. [Jekyll]: http://jekyllrb.com/ [Middleman]: https://middlemanapp.com/ [Nanoc]: http://nanoc.ws/ I wanted to develop a fast and full-featured website framework without any dependencies. The [Go language][] seemed to have all the features I needed in a language. I began developing Hugo in Go and fell in love with the language. I hope you will enjoy using Hugo (and contributing to it) as much as I have writing it. —Steve Francia (@spf13) [Go language]: http://golang.org/ "The Go Programming Language" ## Next Steps * [Install Hugo](/overview/installing/) * [Quick start](/overview/quickstart/) * [Join the Mailing List](/community/mailing-list/) * [Star us on GitHub](https://github.com/spf13/hugo) * [Discussion Forum](http://discuss.gohugo.io/) hugo-0.18.1/docs/content/overview/quickstart.md000066400000000000000000000447341303124201100215260ustar00rootroot00000000000000--- lastmod: 2016-10-20 date: 2013-07-01 linktitle: Quickstart menu: main: parent: getting started next: /overview/installing prev: /overview/introduction title: Hugo Quickstart Guide weight: 10 --- Building a bookshelf --- In this quickstart, we will build an online bookshelf that will list books and their reviews. > _Note: This quickstart depends on features introduced in Hugo v0.15. If you have an earlier version of Hugo, you will need to [upgrade](/overview/installing/) before proceeding._ {{% youtube w7Ft2ymGmfc %}} ## Step 1. Install Hugo Go to [Hugo Releases](https://github.com/spf13/hugo/releases) and download the appropriate version for your OS and architecture. Save the main executable as `hugo` (or `hugo.exe` on Windows) somewhere in your `PATH` as we will be using it in the next step. More complete instructions are available at [Installing Hugo]({{< relref "overview/installing.md" >}}). If you're on Windows, this quickstart will assume you're using [Git Bash](https://git-for-windows.github.io/) (also known as Git for Windows). Thus all commands will begin with the Bash prompt character (which is `$`). Once `hugo` is installed, make sure to run the `help` command to verify `hugo` installation. Below you can see part of the `help` command output for brevity. ```bash $ hugo help ``` ``` hugo is the main command, used to build your Hugo site. Hugo is a Fast and Flexible Static Site Generator built with love by spf13 and friends in Go. Complete documentation is available at http://gohugo.io/. ``` You can check `hugo` version using the command shown below. ```bash $ hugo version ``` ``` Hugo Static Site Generator v0.15 BuildDate: 2015-11-26T11:59:00+05:30 ``` ## Step 2. Scaffold bookshelf hugo site Hugo has commands that allows us to quickly scaffold a Hugo managed website. Navigate to a convenient location on your filesystem and create a new Hugo site `bookshelf` by executing the following command. ```bash $ hugo new site bookshelf ``` Change directory to `bookshelf` and you will see the following directory layout. ```bash $ tree -a ``` ``` . |-- archetypes |-- config.toml |-- content |-- data |-- layouts `-- static 5 directories, 1 file ``` As mentioned in the command output, `bookshelf` directory has 5 sub-directories and 1 file. Let's look at each of them one by one. * **archetypes**: You can create new content files in Hugo using the `hugo new` command. When you run that command, it adds few configuration properties to the post like date and title. [Archetype]({{< relref "content/archetypes.md" >}}) allows you to define your own configuration properties that will be added to the post front matter whenever `hugo new` command is used. * **config.toml**: Every website should have a configuration file at the root. By default, the configuration file uses `TOML` format but you can also use `YAML` or `JSON` formats as well. [TOML](https://github.com/toml-lang/toml) is minimal configuration file format that's easy to read due to obvious semantics. The configuration settings mentioned in the `config.toml` are applied to the full site. These configuration settings include `baseURL` and `title` of the website. * **content**: This is where you will store content of the website. Inside content, you will create sub-directories for different sections. Let's suppose your website has three actions -- `blog`, `article`, and `tutorial` then you will have three different directories for each of them inside the `content` directory. The name of the section i.e. `blog`, `article`, or `tutorial` will be used by Hugo to apply a specific layout applicable to that section. * **data**: This directory is used to store configuration files that can be used by Hugo when generating your website. You can write these files in YAML, JSON, or TOML format. * **layouts**: The content inside this directory is used to specify how your content will be converted into the static website. * **static**: This directory is used to store all the static content that your website will need like images, CSS, JavaScript or other static content. ## Step 3. Add content Let's now add a post to our `bookshelf`. We will use the `hugo new` command to add a post. In January, I read [Good To Great](http://www.amazon.com/Good-Great-Some-Companies-Others/dp/0066620996/) book so we will start with creating a post for it. **Make sure you are inside the `bookshelf` directory.** ```bash $ hugo new post/good-to-great.md ``` ``` /Users/shekhargulati/bookshelf/content/post/good-to-great.md created ``` The above command will create a new directory `post` inside the `bookshelf/content` directory and create `good-to-great.md` file inside it. ```bash $ tree -a content ``` ``` content `-- post `-- good-to-great.md 1 directory, 1 file ``` The content inside the `good-to-great.md` file looks as shown below. ``` +++ date = "2016-02-14T16:11:58+05:30" draft = true title = "good to great" +++ ``` The content inside `+++` is the TOML configuration for the post. This configuration is called **front matter**. It enables you to define post configuration along with its content. By default, each post will have the three configuration properties shown above. * **date** specifies the date and time at which post was created. * **draft** specifies that post is not ready for publication yet so it will not be in the generated site. * **title** specifies title for the post. Let's add a small review for **Good to Great** book. ``` +++ date = "2016-02-14T16:11:58+05:30" draft = true title = "Good to Great Book Review" +++ I read **Good to Great in January 2016**. An awesome read sharing detailed analysis on how good companies became great. ``` ## Step 4. Serve content Hugo has an inbuilt server that can serve your website content so that you can preview it. You can also use the inbuilt Hugo server in production. To serve content, execute the following command inside the `bookshelf` directory. ```bash $ hugo server ``` ``` 0 of 1 draft rendered 0 future content 0 pages created 0 paginator pages created 0 tags created 0 categories created in 9 ms Watching for changes in /Users/shekhargulati/bookshelf/{data,content,layouts,static} Serving pages from memory Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) Press Ctrl+C to stop ``` This will start the server on port `1313`. You can view your blog at http://localhost:1313/. When you go to the link, you will see nothing. There are couple of reasons for that: 1. As you can see in the `hugo server` command output, Hugo didn't render the draft. Hugo will only render drafts if you pass the `buildDrafts` flag to the `hugo server` command. 2. We have not specified how Markdown content should be rendered. We have to specify a theme that Hugo can use. We will do that in the next step. To render drafts, re-run the server with command shown below. ```bash $ hugo server --buildDrafts ``` ``` 1 of 1 draft rendered 0 future content 1 pages created 0 paginator pages created 0 tags created 0 categories created in 6 ms Watching for changes in /Users/shekhargulati/bookshelf/{data,content,layouts,static} Serving pages from memory Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) Press Ctrl+C to stop ``` If you go to [http://localhost:1313/](http://localhost:1313/), you still will not see anything as we have not specified a theme that Hugo should use. ## Step 5. Add theme Themes provide the layout and templates that will be used by Hugo to render your website. There are a lot of Open-source themes available at [https://themes.gohugo.io/](https://themes.gohugo.io/) that you can use. > **Hugo currently doesn’t ship with a `default` theme, allowing the user to pick whichever theme best suits their project.** Themes should be added in the `themes` directory inside the repository root. ```bash $ cd themes ``` Now, you can clone one or more themes inside the `themes` directory. We will use the `robust` theme, but at a commit (in its history) that works with this quickstart. ```bash $ git clone https://github.com/dim0627/hugo_theme_robust.git $ (cd hugo_theme_robust; git checkout b8ce466) ``` Leave the themes folder. ```bash $ cd .. ``` Start the server again. ```bash $ hugo server --theme=hugo_theme_robust --buildDrafts ``` ``` 1 of 1 draft rendered 0 future content 1 pages created 2 paginator pages created 0 tags created 0 categories created in 10 ms Watching for changes in /Users/shekhargulati/bookshelf/{data,content,layouts,static,themes} Serving pages from memory Web Server is available at http://localhost:1313/ (bind address 127.0.0.1) Press Ctrl+C to stop ``` > *Note: If Hugo doesn't find the specified theme in the `themes` directory, it will throw an exception as shown below.* ``` FATAL: 2016/02/14 Unable to find theme Directory: /Users/shekhargulati/bookshelf/themes/robust ``` To view your website, you can go to http://localhost:1313/. You will see as shown below. ![](/img/quickstart/bookshelf-robust-theme.png) Let's understand the layout of the theme. A theme consists of the following: * **theme.toml** is the theme configuration file that gives information about the theme like name and description of theme, author details, and theme license. * **images** directory contains two images -- `screenshot.png` and `tn.png`. `screenshot.png` is the image of the list view and `tn.png` is the single post view. * **layouts** directory contains different views for different content types. Every content type should have two files `single.html` and `list.html`. `single.html` is used for rendering a single piece of content. `list.html` is used to view a list of content items. For example, you will use `list.html` to view all the posts that have the `programming` tag. * **static** directory stores all the static assets used by the template. Static assets could be JavaScript libraries like jQuery or CSS styles or images, or any other static content. This directory will be copied into the final site when rendered. ## Step 6. Use multiple themes You can very easily test different layouts by switching between different themes. Let's suppose we want to try out the `bleak` theme. We clone the `bleak` theme inside the `bookshelf/themes` directory. ```bash $ git clone https://github.com/Zenithar/hugo-theme-bleak.git ``` Restart the server using `hugo-theme-bleak` as shown below. ```bash $ hugo server --theme=hugo-theme-bleak --buildDrafts ``` Now, the website will use the `bleak` theme and will be rendered differently as shown below. ![](/img/quickstart/bookshelf-bleak-theme.png) ## Step 7. Update config.toml and live reloading in action Restart the server with the `robust` theme, as we will use it in this quickstart. ```bash $ hugo server --theme=hugo_theme_robust --buildDrafts ``` The website uses the dummy values specified in `bookshelf/config.toml`. Let's update the configuration. ```toml baseURL = "http://example.org/" languageCode = "en-us" title = "Shekhar Gulati Book Reviews" [Params] Author = "Shekhar Gulati" ``` Hugo has inbuilt support for live reloading. So, as soon as you save your changes it will apply the change and reload the web page. You will see the changes shown below. ![](/img/quickstart/bookshelf-updated-config.png) The same is reflected in the Hugo server logs as well. As soon as you changed the configuration file, Hugo applied those changes to the affected pages. ``` Config file changed: /Users/shekhargulati/bookshelf/config.toml 1 of 1 draft rendered 0 future content 1 pages created 2 paginator pages created 0 tags created 0 categories created in 11 ms ``` ## Step 8. Customize robust theme The `robust` theme is a good start towards our online bookshelf but we want to customize it a bit to meet the look and feel required for the bookshelf. Hugo makes it very easy to customize themes. You can also create your themes but we will not do that today. If you want to create your own theme, then you should refer to the [Hugo documentation]({{< relref "themes/creation.md" >}}). The first change that we have to make is to use a different default image instead of the one used in the theme. The theme's default image used in both the list and single view page resides inside `themes/hugo_theme_robust/static/images/default.jpg`. We can easily override it by creating a simple directory structure inside the repository's `static` directory. Create an images directory inside the `bookshelf/static` directory and copy an image with name `default.jpg` inside it. We will use the default image shown below. ![](/img/quickstart/default.jpg) Hugo will sync the changes and reload the website to use new image as shown below. ![](/img/quickstart/bookshelf-new-default-image.png) Now, we need to change the layout of the index page so that only images are shown instead of the text. The index.html inside the layouts directory of the theme refer to partial `li` that renders the list view shown below. ```html ``` Create a new file li.html inside the `bookshelf/layouts/_default` directory. Copy the content shown below into the li.html. We have removed details of the book so that only image is shown. ```html ``` Now, the website will be rendered as shown below. ![](/img/quickstart/bookshelf-only-picture.png) Next, we want to remove information related to theme from the footer. So, create a new directory `partials` inside `bookshelf/layouts`. There, create a new file `default_foot.html` with the content copied from the theme's `layouts/partials/default_foot.html`. Replace the footer section with the one shown below. ```html

{{ with .Site.Copyright | safeHTML }}{{ . }}{{ else }}© {{ $.Site.LastChange.Year }} {{ if isset $.Site.Params "Author" }}{{ $.Site.Params.Author }}{{ else }}{{ .Site.Title }}{{ end }}{{ end }}

Powered by Hugo,

``` We also have to remove the sidebar on the right. Copy the `index.html` from the theme's `layouts` directory to the `bookshelf/layouts` directory. Remove the section related to the sidebar from the HTML: ```html
{{ partial "sidebar.html" . }}
``` So far we are using the default image but we would like to use the book image so that we can relate to the book. Every book review will define a configuration setting in its front matter. Update the `good-to-great.md` as shown below. ``` +++ date = "2016-02-14T16:11:58+05:30" draft = true title = "Good to Great Book Review" image = "good-to-great.jpg" +++ I read **Good to Great in January 2016**. An awesome read sharing detailed analysis on how good companies became great. Although this book is about how companies became great but we could apply a lot of the learnings on ourselves. Concepts like level 5 leader, hedgehog concept, the stockdale paradox are equally applicable to individuals. ``` Grab a (legal) image from somewhere, name it `good-to-great.jpg`, and place it in the `bookshelf/static/images` directory. After adding few more books to our shelf, the shelf appears as shown below. These are a few of the books that I have read within the last year. ![](/img/quickstart/bookshelf.png) ## Step 9. Make posts public So far all the posts that we have written are in draft status. To make a draft public, you can either run a command or manually change the draft status in the post to `false`. ```bash $ hugo undraft content/post/good-to-great.md ``` Now, you can start the server without the `buildDrafts` option. ``` $ hugo server --theme=hugo_theme_robust ``` ## Step 10. Integrate Disqus Disqus allows you to integrate comments in your static blog. To enable Disqus, you just have to set `disqusShortname` in the config.toml as shown below. ``` [Params] Author = "Shekhar Gulati" disqusShortname = ``` Now, commenting will be enabled in your blog. ![](/img/quickstart/bookshelf-disqus.png) ## Step 11. Generate website To generate Hugo website source you can use to deploy your website on GitHub pages, first edit `bookshelf/config.toml`, changing the `baseURL` line to: ``` baseURL = "https://.github.io/bookshelf/" ``` Then type the following command. ```bash $ hugo --theme=hugo_theme_robust ``` ``` 0 draft content 0 future content 5 pages created 2 paginator pages created 0 tags created 0 categories created in 17 ms ``` After you run the `hugo` command, a `bookshelf/public` directory will be created containing the generated website source. BTW (in case you tried), the website isn't properly accessible via the `file:///` protocol. ## Step 12. Deploy bookshelf on GitHub pages Let's version control your bookshelf: ```bash $ git init $ echo "/public/" >> .gitignore $ echo "/themes/" >> .gitignore $ git add --all $ git commit -m "Initial commit" ``` Now the Git repositories under `bookshelf/themes` won't conflict with your `bookshelf` repository, and neither will a Git repository in `bookshelf/public`. Create a new repository on GitHub named `bookshelf` (without a README). Once that's done, create a new Git repository on your local system in `bookshelf/public` and add remote: ```bash $ cd public $ git init $ git remote add origin git@github.com:/bookshelf.git ``` There, create and check out a new branch `gh-pages`. ```bash $ git checkout -b gh-pages Switched to a new branch 'gh-pages' ``` Add all the files (within `bookshelf/public`) to the index, commit them, and push the changes to GitHub. ```bash $ git add --all $ git commit -m "bookshelf added" $ git push -f origin gh-pages ``` In couple of minutes, your website will be live at `https://.github.io/bookshelf/`. Anytime, you can regenerate your site with: ```bash $ (cd ..; hugo --theme=hugo_theme_robust) $ git add --all $ git commit -m "" $ git push -f origin gh-pages ``` ---- This quickstart was originally written by [Shekhar Gulati](https://twitter.com/shekhargulati) in his [52 Technologies in 2016](https://github.com/shekhargulati/52-technologies-in-2016) blog series. hugo-0.18.1/docs/content/overview/source-directory.md000066400000000000000000000073001303124201100226220ustar00rootroot00000000000000--- aliases: - /doc/source-directory/ lastmod: 2015-02-09 date: 2013-07-01 menu: main: parent: getting started next: /content/organization notoc: true prev: /overview/configuration title: Source Organization weight: 50 --- Hugo takes a single directory and uses it as the input for creating a complete website. The top level of a source directory will typically have the following elements: ▸ archetypes/ ▸ content/ ▸ data/ ▸ i18n/ ▸ layouts/ ▸ static/ ▸ themes/ config.toml Learn more about the different directories and what their purpose is: * [config]({{< relref "overview/configuration.md" >}}) * [data]({{< relref "extras/datafiles.md" >}}) * [i18n]({{< relref "content/multilingual.md#translation-of-strings" >}}) * [archetypes]({{< relref "content/archetypes.md" >}}) * [content]({{< relref "content/organization.md" >}}) * [layouts]({{< relref "templates/overview.md" >}}) * [static]({{< relref "themes/creation.md#static" >}}) * [themes]({{< relref "themes/overview.md" >}}) ## Example An example directory may look like: . ├── config.toml ├── archetypes | └── default.md ├── content | ├── post | | ├── firstpost.md | | └── secondpost.md | └── quote | | ├── first.md | | └── second.md ├── data ├── i18n ├── layouts | ├── _default | | ├── single.html | | └── list.html | ├── partials | | ├── header.html | | └── footer.html | ├── taxonomies | | ├── category.html | | ├── post.html | | ├── quote.html | | └── tag.html | ├── post | | ├── li.html | | ├── single.html | | └── summary.html | ├── quote | | ├── li.html | | ├── single.html | | └── summary.html | ├── shortcodes | | ├── img.html | | ├── vimeo.html | | └── youtube.html | ├── index.html | └── sitemap.xml ├── themes | ├── hyde | └── doc └── static ├── css └── js This directory structure tells us a lot about this site: 1. The website intends to have two different types of content: *posts* and *quotes*. 2. It will also apply two different taxonomies to that content: *categories* and *tags*. 3. It will be displaying content in 3 different views: a list, a summary and a full page view. ## Content for home page and other list pages Since Hugo 0.18, "everything" is a `Page` that can have content and metadata, like `.Params`, attached to it -- and share the same set of [page variables](/templates/variables/). To add content and frontmatter to the home page, a section, a taxonomy or a taxonomy terms listing, add a markdown file with the base name `_index` on the relevant place on the file system. For the default Markdown content, the filename will be `_index.md`. Se the example directory tree below. **Note that you don't have to create `_index` file for every section, taxonomy and similar, a default page will be created if not present, but with no content an default values for `.Title` etc.** ```bash └── content ├── _index.md ├── categories │   ├── _index.md │   └── photo │   └── _index.md ├── post │   ├── _index.md │   └── firstpost.md └── tags ├── _index.md └── hugo └── _index.md ``` hugo-0.18.1/docs/content/overview/usage.md000066400000000000000000000210671303124201100204320ustar00rootroot00000000000000--- aliases: - /doc/usage/ lastmod: 2016-08-19 date: 2013-07-01 menu: main: parent: getting started next: /overview/configuration notoc: true prev: /overview/installing title: Using Hugo weight: 30 --- Make sure Hugo is in your `PATH` (or provide a path to it). Test this by: {{< nohighlight >}}$ hugo help hugo is the main command, used to build your Hugo site. Hugo is a Fast and Flexible Static Site Generator built with love by spf13 and friends in Go. Complete documentation is available at http://gohugo.io/. Usage: hugo [flags] hugo [command] Available Commands: benchmark Benchmark Hugo by building a site a number of times. config Print the site configuration convert Convert your content to different formats env Print Hugo version and environment info gen A collection of several useful generators. import Import your site from others. list Listing out various types of content new Create new content for your site server A high performance webserver undraft Undraft changes the content's draft status from 'True' to 'False' version Print the version number of Hugo Flags: -b, --baseURL string hostname (and path) to the root, e.g. http://spf13.com/ -D, --buildDrafts include content marked as draft -E, --buildExpired include expired content -F, --buildFuture include content with publishdate in the future --cacheDir string filesystem path to cache directory. Defaults: $TMPDIR/hugo_cache/ --canonifyURLs if true, all relative URLs will be canonicalized using baseURL --cleanDestinationDir Remove files from destination not found in static directories --config string config file (default is path/config.yaml|json|toml) -c, --contentDir string filesystem path to content directory -d, --destination string filesystem path to write files to --disable404 Do not render 404 page --disableRSS Do not build RSS files --disableSitemap Do not build Sitemap file --enableGitInfo Add Git revision, date and author info to the pages --forceSyncStatic Copy all files when static is changed. --i18n-warnings Print missing translations --ignoreCache Ignores the cache directory -l, --layoutDir string filesystem path to layout directory --log Enable Logging --logFile string Log File path (if set, logging enabled automatically) --noChmod Don't sync permission mode of files --noTimes Don't sync modification time of files --pluralizeListTitles Pluralize titles in lists using inflect (default true) --preserveTaxonomyNames Preserve taxonomy names as written ("Gérard Depardieu" vs "gerard-depardieu") --quiet build in quiet mode --renderToMemory render to memory (only useful for benchmark testing) -s, --source string filesystem path to read files relative from --stepAnalysis display memory and timing of different steps of the program -t, --theme string theme to use (located in /themes/THEMENAME/) --uglyURLs if true, use /filename.html instead of /filename/ -v, --verbose verbose output --verboseLog verbose logging -w, --watch watch filesystem for changes and recreate as needed Additional help topics: hugo check Contains some verification checks Use "hugo [command] --help" for more information about a command. {{< /nohighlight >}} ## Common Usage Example The most common use is probably to run `hugo` with your current directory being the input directory: {{< nohighlight >}}$ hugo 0 draft content 0 future content 99 pages created 0 paginator pages created 16 tags created 0 groups created in 120 ms {{< /nohighlight >}} This generates your web site to the `public/` directory, ready to be deployed to your web server. ## Instant feedback as you develop your web site If you are working on things and want to see the changes immediately, by default Hugo will watch the filesystem for changes, and rebuild your site as soon as a file is saved: {{< nohighlight >}}$ hugo -s ~/Code/hugo/docs 0 draft content 0 future content 99 pages created 0 paginator pages created 16 tags created 0 groups created in 120 ms Watching for changes in /Users/spf13/Code/hugo/docs/content Press Ctrl+C to stop {{< /nohighlight >}} Hugo can even run a server and create a site preview at the same time! Hugo implements [LiveReload](/extras/livereload/) technology to automatically reload any open pages in all JavaScript-enabled browsers, including mobile. This is the easiest and most common way to develop a Hugo web site: {{< nohighlight >}}$ hugo server -ws ~/Code/hugo/docs 0 draft content 0 future content 99 pages created 0 paginator pages created 16 tags created 0 groups created in 120 ms Watching for changes in /Users/spf13/Code/hugo/docs/content Serving pages from /Users/spf13/Code/hugo/docs/public Web Server is available at http://localhost:1313/ Press Ctrl+C to stop {{< /nohighlight >}} ## Deploying your web site After running `hugo server` for local web development, you need to do a final `hugo` run **without the `server` part of the command** to rebuild your site. You may then **deploy your site** by copying the `public/` directory (by FTP, SFTP, WebDAV, Rsync, `git push`, etc.) to your production web server. Since Hugo generates a static website, your site can be hosted anywhere, including [Heroku][], [GoDaddy][], [DreamHost][], [GitHub Pages][], [Amazon S3][] with [CloudFront][], [Firebase Hosting][], or any other cheap (or even free) static web hosting service. [Apache][], [nginx][], [IIS][]... Any web server software would do! [Apache]: http://httpd.apache.org/ "Apache HTTP Server" [nginx]: http://nginx.org/ [IIS]: http://www.iis.net/ [Heroku]: https://www.heroku.com/ [GoDaddy]: https://www.godaddy.com/ [DreamHost]: http://www.dreamhost.com/ [GitHub Pages]: https://pages.github.com/ [GitLab]: https://about.gitlab.com [Amazon S3]: http://aws.amazon.com/s3/ [CloudFront]: http://aws.amazon.com/cloudfront/ "Amazon CloudFront" [Firebase Hosting]: https://firebase.google.com/docs/hosting/ ### A note about deployment Running `hugo` *does not* remove generated files before building. This means that you should delete your `public/` directory (or the directory you specified with `-d`/`--destination`) before running the `hugo` command, or you run the risk of the wrong files (e.g. drafts and/or future posts) being left in the generated site. An easy way to work around this is to use different directories for development and production. To start a server that builds draft content (helpful for editing), you can specify a different destination: the `dev/` dir. {{< nohighlight >}}$ hugo server -wDs ~/Code/hugo/docs -d dev {{< /nohighlight >}} When the content is ready for publishing, use the default `public/` dir: {{< nohighlight >}}$ hugo -s ~/Code/hugo/docs {{< /nohighlight >}} This prevents content you're not yet ready to share from accidentally becoming available. ### Alternatively, serve your web site with Hugo! Yes, that's right! Because Hugo is so blazingly fast both in web site creation *and* in web serving (thanks to its concurrent and multi-threaded design and its Go heritage), some users actually prefer using Hugo itself to serve their web site *on their production server*! No other web server software (Apache, nginx, IIS...) is necessary. Here is the command: {{< nohighlight >}}$ hugo server --baseURL=http://yoursite.org/ \ --port=80 \ --appendPort=false \ --bind=87.245.198.50 {{< /nohighlight >}} Note the `bind` option, which is the interface to which the server will bind (defaults to `127.0.0.1`: fine for most development use cases). Some hosts, such as Amazon Web Services, run NAT (network address translation); sometimes it can be hard to figure out the actual IP address. Using `--bind=0.0.0.0` will bind to all interfaces. This way, you may actually deploy just the source files, and Hugo on your server will generate the resulting web site on-the-fly and serve them at the same time. You may optionally add `--disableLiveReload=true` if you do not want the JavaScript code for LiveReload to be added to your web pages. Interested? Here are some great tutorials contributed by Hugo users: * [hugo, syncthing](http://fredix.xyz/2014/10/hugo-syncthing/) (French) by Frédéric Logier (@fredix) hugo-0.18.1/docs/content/showcase/000077500000000000000000000000001303124201100167445ustar00rootroot00000000000000hugo-0.18.1/docs/content/showcase/2626info.md000066400000000000000000000003301303124201100205350ustar00rootroot00000000000000--- date: 2016-05-03T17:20:59+09:00 description: "Personal blog of Masashi Tsuru" license: "" licenseLink: "" sitelink: http://2626.info/ tags: - personal - blog thumbnail: /img/2626info-tn.png title: 2626.info --- hugo-0.18.1/docs/content/showcase/antzucaro.md000066400000000000000000000004341303124201100212750ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2014-02-03T20:00:00Z description: Ant Zucaro's Blog license: GPL licenseLink: "" sitelink: http://antzucaro.com/ sourceLink: https://github.com/antzucaro/az.com tags: - personal - blog - foundation thumbnail: /img/antzucaro-tn.jpg title: Ant Zucaro --- hugo-0.18.1/docs/content/showcase/appernetic.md000066400000000000000000000005761303124201100214300ustar00rootroot00000000000000--- lastmod: 2016-04-26 date: 2016-04-26T13:33:33Z description: Appernetic.io blog license: MIT licenseLink: https://github.com/appernetic/hugo-bootstrap-premium/blob/master/LICENSE.md sitelink: https://blog.appernetic.io/ sourceLink: https://github.com/appernetic/hugo-bootstrap-premium tags: - company - blog - bootstrap thumbnail: /img/apperneticioblog.png title: Appernetic --- hugo-0.18.1/docs/content/showcase/arresteddevops.md000066400000000000000000000006541303124201100223250ustar00rootroot00000000000000--- lastmod: 2015-11-20 date: 2015-11-20T01:46:33-06:00 description: "Arrested DevOps is a podcast focusing on trends in the DevOps space" license: "apache2" licenseLink: "https://github.com/arresteddevops/ado-hugo/blob/master/LICENSE.md" sitelink: https://www.arresteddevops.com/ sourceLink: https://github.com/arresteddevops/ado-hugo tags: - podcast - bootstrap thumbnail: /img/arresteddevops-tn.png title: arresteddevops --- hugo-0.18.1/docs/content/showcase/asc.md000066400000000000000000000004361303124201100200370ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2014-01-22T07:32:00Z description: "" license: CC-BY-SA licenseLink: "" sitelink: http://andrewcodispoti.com/ sourceLink: https://gitlab.com/acodispo/andrewcodispoti-com tags: - personal - bootstrap thumbnail: /img/asc-tn.jpg title: Andrew S Codispoti --- hugo-0.18.1/docs/content/showcase/astrochili.md000066400000000000000000000004221303124201100214250ustar00rootroot00000000000000--- date: 2016-07-31T11:22:32+03:00 description: "Personal website" license: "" licenseLink: "" sitelink: http://romansilin.com/ sourceLink: https://github.com/astrochili/astrochili.github.io tags: - personal - blog thumbnail: /img/astrochili-tn.png title: Roman Silin --- hugo-0.18.1/docs/content/showcase/aydoscom.md000066400000000000000000000003041303124201100211010ustar00rootroot00000000000000--- date: 2016-04-23T13:23:00Z description: "web applications" license: "" licenseLink: "" sitelink: https://aydos.com/ tags: - web applications thumbnail: /img/aydoscom.png title: aydos.com --- hugo-0.18.1/docs/content/showcase/balaramadurai.net.md000066400000000000000000000005751303124201100226470ustar00rootroot00000000000000--- date: 2016-11-17T12:27:18+05:30 description: "Dr. Bala Ramadurai, Professor & Consultant in Innovation, Design Thinking and Tech Forecasting" license: "" licenseLink: "" sitelink: http://balaramadurai.net tags: - personal - blog thumbnail: /img/balaramadurai-net-tn.png title: Dr. Bala Ramadurai | Professor & Consultant in Innovation, Design Thinking and Tech Forecasting --- hugo-0.18.1/docs/content/showcase/barricade.md000066400000000000000000000003661303124201100212070ustar00rootroot00000000000000--- date: 2016-04-15T14:14:28+01:00 description: "Barricade is an early warning system against hackers." license: "" licenseLink: "" sitelink: https://barricade.io tags: - company - security thumbnail: /img/barricade-tn.png title: Barricade --- hugo-0.18.1/docs/content/showcase/bepsays.md000066400000000000000000000004071303124201100207350ustar00rootroot00000000000000--- lastmod: 2015-05-26 date: 2013-11-01T07:32:00Z description: "bep's blog" license: "" licenseLink: "" sitelink: http://bepsays.com/ sourceLink: "https://github.com/bep/bepsays.com" tags: - personal - blog thumbnail: /img/bepsays-tn.png title: bepsays.com --- hugo-0.18.1/docs/content/showcase/bugtrackers.io.md000066400000000000000000000005531303124201100222130ustar00rootroot00000000000000--- lastmod: 2015-10-27 date: 2015-10-27T09:02:00Z description: bugtrackers.io provides stories of digital crafters. It shows people behind bits, pixels and bug reports. bugtrackers.io is your resource for web development. sitelink: https://www.bugtrackers.io/ tags: - blog - community - interviews thumbnail: /img/bugtrackersio-tn.jpg title: bugtrackers.io --- hugo-0.18.1/docs/content/showcase/camunda-blog.md000066400000000000000000000005351303124201100216220ustar00rootroot00000000000000--- lastmod: 2015-11-30 date: 2015-12-01T04:20:00Z description: "Camunda BPM Team Blog" license: "Apache 2.0" licenseLink: "https://github.com/camunda/blog.camunda.org#license" sitelink: http://blog.camunda.org/ sourceLink: https://github.com/camunda/blog.camunda.org tags: - company - blog thumbnail: /img/camunda-blog.png title: Camunda Blog --- hugo-0.18.1/docs/content/showcase/camunda-docs.md000066400000000000000000000005451303124201100216300ustar00rootroot00000000000000--- lastmod: 2015-11-30 date: 2015-12-01T04:20:00Z description: "Camunda BPM Documentation" license: MIT licenseLink: "https://github.com/camunda/camunda-docs-theme#licence" sitelink: http://docs.camunda.org/ sourceLink: https://github.com/camunda/camunda-docs-theme tags: - company - documentation thumbnail: /img/camunda-docs.png title: Camunda Docs --- hugo-0.18.1/docs/content/showcase/cdnoverview.md000066400000000000000000000004251303124201100216220ustar00rootroot00000000000000--- date: 2016-02-17T15:19:08+01:00 description: "Overview and comparison of CDNs, their features and prices" license: "" licenseLink: "" sitelink: https://www.cdnoverview.com/ tags: - bootstrap - portfolio - tech thumbnail: /img/cdnoverview-tn.png title: cdnoverview.com --- hugo-0.18.1/docs/content/showcase/chinese-grammar.md000066400000000000000000000004341303124201100223310ustar00rootroot00000000000000--- lastmod: 2015-08-21 date: 2015-08-23 description: Chinese grammar lessons sitelink: https://www.chineseboost.com/grammar/ sourceLink: https://github.com/hughgrigg/chineseboost-articles tags: - learning - education thumbnail: /img/chinese-grammar-tn.png title: Chinese Grammar --- hugo-0.18.1/docs/content/showcase/chingli.md000066400000000000000000000003611303124201100207030ustar00rootroot00000000000000--- lastmod: 2015-12-19 date: 2014-08-26T11:20:02-04:00 description: "chingli’s personal blog" sitelink: http://www.chingli.com/ tags: - personal - blog thumbnail: /img/chingli-tn.jpg title: 青砾 (chingli) --- hugo-0.18.1/docs/content/showcase/chipsncookies.md000066400000000000000000000005201303124201100221240ustar00rootroot00000000000000--- lastmod: 2016-04-14 date: 2015-07-08T14:02:16+02:00 description: "personal blog and portfolio of Samuel Debruyn" license: "" licenseLink: "" sitelink: https://chipsncookies.com sourceLink: https://github.com/SamuelDebruyn/chipsncookies-site tags: - personal - blog thumbnail: /img/chipsncookies-tn.png title: Chips 'n' Cookies --- hugo-0.18.1/docs/content/showcase/christianmendoza.md000066400000000000000000000003461303124201100226330ustar00rootroot00000000000000--- date: 2016-10-16T13:30:47-04:00 description: "Personal site" license: "" licenseLink: "" sitelink: https://christianmendoza.me/ tags: - personal - profile thumbnail: /img/christianmendoza-tn.png title: christianmendoza.me --- hugo-0.18.1/docs/content/showcase/cinegyopen.md000066400000000000000000000003571303124201100214330ustar00rootroot00000000000000--- date: 2016-09-05T23:23:18+02:00 description: "Cinegy Open documentation project" license: "" licenseLink: "" sitelink: https://open.cinegy.com/ sourceLink: tags: - documentation thumbnail: /img/cinegyopen-tn.png title: Cinegy Open ---hugo-0.18.1/docs/content/showcase/clearhaus.md000066400000000000000000000004371303124201100212410ustar00rootroot00000000000000--- date: 2016-10-21T12:37:00+02:00 description: "Online Acquiring · Accept Visa & MasterCard within 1-3 days" license: "" licenseLink: "" sitelink: https://www.clearhaus.com/ tags: - company - fintech - payments - acquirer thumbnail: /img/clearhaus-tn.png title: Clearhaus --- hugo-0.18.1/docs/content/showcase/cloudshark.md000066400000000000000000000004361303124201100214300ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2014-03-27T09:45:00Z description: CloudShark Appliance homepage and documentation license: "" licenseLink: "" sitelink: https://appliance.cloudshark.org/ tags: - company - documentation - foundation thumbnail: /img/cloudshark-tn.jpg title: CloudShark --- hugo-0.18.1/docs/content/showcase/coding-journal.md000066400000000000000000000004431303124201100222020ustar00rootroot00000000000000--- lastmod: 2015-12-23 date: 2015-12-23T11:42:00+01:00 description: blog, portfolio license: "" licenseLink: "" sitelink: http://blog.kulman.sk/ sourceLink: https://github.com/igorkulman/coding-journal tags: - blog - portfolio thumbnail: /img/codingjournal-tn.png title: Coding Journal --- hugo-0.18.1/docs/content/showcase/consequently.md000066400000000000000000000005241303124201100220200ustar00rootroot00000000000000--- lastmod: 2015-02-11 date: 2015-02-11T13:21:27+11:00 description: "consequently.org, Greg Restall's personal website" license: "" licenseLink: "" sitelink: http://consequently.org sourceLink: "https://github.com/consequently/consequently-hugo" tags: - academic - blog - kube thumbnail: /img/consequently.jpg title: consequently.org --- hugo-0.18.1/docs/content/showcase/ctlcompiled.md000066400000000000000000000010711303124201100215640ustar00rootroot00000000000000--- date: 2016-07-25T13:45:09-04:00 description: "CompilED is a collection of reflections and comments by the software developers at Columbia’s Center for Teaching and Learning (CTL). These views are rooted in our professional and personal experiences developing educational technology." license: "Creative Commons Attribution-ShareAlike 3.0 United States." licenseLink: "https://creativecommons.org/licenses/by-sa/3.0/us/" sitelink: https://compiled.ctl.columbia.edu/ tags: - edtech - technology - blog thumbnail: /img/ctlcompiled-tn.png title: CompilED at CTL --- hugo-0.18.1/docs/content/showcase/danmux.md000066400000000000000000000003751303124201100205670ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-26T10:55:23-04:00 description: "" license: MIT licenseLink: "" sitelink: http://danmux.com/ sourceLink: https://github.com/danmux/danmux-hugo tags: - personal - blog thumbnail: /img/danmux-tn.jpg title: Danmux --- hugo-0.18.1/docs/content/showcase/datapipelinearchitect.md000066400000000000000000000004121303124201100236110ustar00rootroot00000000000000--- date: 2016-02-04T18:30:07-05:00 description: "Professional website at datapipelinearchitect.com" sitelink: http://datapipelinearchitect.com/ tags: - company - tech - blog - website thumbnail: /img/datapipelinearchitect-tn.jpg title: Data Pipeline Architect --- hugo-0.18.1/docs/content/showcase/davidepetilli.md000066400000000000000000000003651303124201100221110ustar00rootroot00000000000000--- lastmod: 2015-05-25 date: 2013-11-01T07:32:00Z description: "" license: MIT licenseLink: "" sitelink: http://davidepetilli.com tags: - personal - photography - portfolio - blog thumbnail: /img/davidepetilli-tn.jpg title: Davide Petilli --- hugo-0.18.1/docs/content/showcase/davidrallen.md000066400000000000000000000005151303124201100215540ustar00rootroot00000000000000--- date: 2016-02-03T11:49:07-05:00 description: "Personal website for David Allen" license: "MIT" licenseLink: "https://opensource.org/licenses/MIT" sitelink: http://davidrallen.com/ sourceLink: https://github.com/doctorallen/davidrallen.com tags: - personal - blog - tech thumbnail: /img/davidrallen-tn.png title: David Allen --- hugo-0.18.1/docs/content/showcase/davidyates.md000066400000000000000000000003141303124201100214210ustar00rootroot00000000000000--- date: 2016-09-10T07:07:39+02:00 description: "David Yates" license: "" licenseLink: "" sitelink: https://davidyat.es/ tags: - personal - blog thumbnail: /img/davidyates-tn.png title: David Yates --- hugo-0.18.1/docs/content/showcase/devmonk.md000066400000000000000000000004061303124201100207310ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-26T11:31:02-04:00 description: "" license: "" licenseLink: "" sitelink: https://devmonk.com/ sourceLink: https://github.com/peteraba/devmonk.com tags: - educational - video thumbnail: /img/devmonk-tn.jpg title: devmonk --- hugo-0.18.1/docs/content/showcase/dmitriid.com.md000066400000000000000000000004171303124201100216520ustar00rootroot00000000000000--- date: 2016-10-19T16:52:28+02:00 description: "Personal blog" license: "CC BY-NC 4.0" licenseLink: "" sitelink: http://dmitriid.com/ sourceLink: https://github.com/dmitriid/dmitriid.com tags: - personal - blog thumbnail: /img/dmitriid.com.png title: dmitriid.com --- hugo-0.18.1/docs/content/showcase/emilyhorsman.com.md000066400000000000000000000004111303124201100225460ustar00rootroot00000000000000--- lastmod: 2016-01-09 date: 2016-01-09T01:00:10Z description: Personal homepage sitelink: https://emilyhorsman.com/ sourceLink: https://github.com/emilyhorsman/buttercup tags: - personal - blog thumbnail: /img/emilyhorsman.com-tn.jpg title: emilyhorsman.com --- hugo-0.18.1/docs/content/showcase/esolia-com.md000066400000000000000000000005121303124201100213140ustar00rootroot00000000000000--- lastmod: 2015-08-08 date: 2015-07-07T04:32:00Z description: Tokyo IT service provider eSolia Inc's Hugo-powered website. license: MIT licenseLink: "" sitelink: http://esolia.com/ sourceLink: https://github.com/eSolia/eSolia tags: - company - esolia - rickcogley - japan thumbnail: /img/esolia_com-tn.png title: eSolia.com --- hugo-0.18.1/docs/content/showcase/esolia-pro.md000066400000000000000000000005371303124201100213450ustar00rootroot00000000000000--- lastmod: 2015-08-08 date: 2015-07-07T04:32:00Z description: Tokyo IT service provider eSolia Inc's eSolia.pro blog site, powered by Hugo. license: MIT licenseLink: "" sitelink: http://esolia.pro/ sourceLink: https://github.com/eSolia/eSolia.pro tags: - company - esolia - rickcogley - japan thumbnail: /img/esolia_pro-tn.png title: eSolia.pro --- hugo-0.18.1/docs/content/showcase/eurie.md000066400000000000000000000003371303124201100204020ustar00rootroot00000000000000--- date: 2016-10-15T23:30:59+09:00 description: "User guide for euire Desk" license: "" licenseLink: "" sitelink: https://docs.eurie.io tags: - documentation thumbnail: /img/docs.eurie.io-tn.png title: eurie Desk docs --- hugo-0.18.1/docs/content/showcase/fale.md000066400000000000000000000004251303124201100201760ustar00rootroot00000000000000--- lastmod: 2016-03-01 date: 2016-03-01T12:38:00Z description: Fabio Alessandro Locati personal blog. license: AGPLv3 licenseLink: "" sitelink: http://fale.io/ sourceLink: https://github.com/fale/fale.io tags: - personal - blog thumbnail: /img/fale-tn.png title: fale.io --- hugo-0.18.1/docs/content/showcase/fixatom.md000066400000000000000000000003061303124201100207340ustar00rootroot00000000000000--- date: 2016-10-17T16:19:24+08:00 description: "a personal blog" license: "" licenseLink: "" sitelink: https://fixatom.com/ tags: - personal - blog thumbnail: /img/fixatom-tn.png title: Atom --- hugo-0.18.1/docs/content/showcase/fxsitecompat.md000066400000000000000000000005711303124201100217770ustar00rootroot00000000000000--- lastmod: 2015-09-08 date: 2014-08-26T19:40:00-04:00 description: Multilingual, community documentation and blog site license: "" licenseLink: "" sitelink: https://www.fxsitecompat.com/ sourceLink: https://github.com/fxsitecompat/www.fxsitecompat.com tags: - community - documentation - translation thumbnail: /img/fxsitecompat-tn.png title: Firefox Site Compatibility --- hugo-0.18.1/docs/content/showcase/gntech.md000066400000000000000000000004371303124201100205420ustar00rootroot00000000000000--- date: 2016-02-13T21:47:27+01:00 description: "Projects, music and drawings, the personal web page of Gustav Näslund" license: "" licenseLink: "" sitelink: http://www.gntech.se/ tags: - personal - blog - projects - music - drawings thumbnail: /img/gntech-tn.png title: gntech.se --- hugo-0.18.1/docs/content/showcase/gogb.md000066400000000000000000000002671303124201100202110ustar00rootroot00000000000000--- lastmod: 2015-05-25 date: 2013-11-01T07:32:00Z description: "" license: MIT licenseLink: "" sitelink: http://getgb.io tags: - project thumbnail: /img/gogb-tn.jpg title: GoGB --- hugo-0.18.1/docs/content/showcase/goin5minutes.md000066400000000000000000000006251303124201100217170ustar00rootroot00000000000000--- lastmod: 2015-11-20 date: 2015-11-20T20:46:00Z description: "Code for Go in 5 Minutes Screencasts" license: "Apache License 2.0" licenseLink: "https://github.com/arschles/go-in-5-minutes/blob/master/LICENSE" sitelink: http://www.goin5minutes.com/ sourceLink: https://github.com/arschles/go-in-5-minutes/tree/master/www tags: - screencasts thumbnail: /img/goin5minutes-tn.png title: Go in 5 minutes ---hugo-0.18.1/docs/content/showcase/h10n.me.md000066400000000000000000000003561303124201100204400ustar00rootroot00000000000000--- date: 2016-03-05T14:30:21+01:00 description: "Personal profile page of Horst Gutmann" sitelink: http://h10n.me/ sourceLink: https://github.com/zerok/h10n.me tags: - personal - profile thumbnail: /img/h10n.me-tn.png title: h10n.me --- hugo-0.18.1/docs/content/showcase/hugo.md000066400000000000000000000004171303124201100202320ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2013-07-01T07:32:00Z description: This site license: Simpl licenseLink: "" sitelink: http://gohugo.io/ sourceLink: https://github.com/spf13/hugo/tree/master/docs tags: - documentation - bootstrap thumbnail: /img/hugo-tn.jpg title: Hugo --- hugo-0.18.1/docs/content/showcase/jamescampbell.md000066400000000000000000000004251303124201100220660ustar00rootroot00000000000000--- date: 2016-06-06T14:42:59-04:00 description: "" license: "" licenseLink: "" sitelink: https://jamescampbell.us/ sourceLink: https://github.com/jamesacampbell/causes-and-effects-hugo tags: - personal - blog thumbnail: /img/jamescampbell-tn.png title: jamescampbell.us --- hugo-0.18.1/docs/content/showcase/jorgennilsson.md000066400000000000000000000004131303124201100221560ustar00rootroot00000000000000--- date: 2016-02-11T23:41:27+01:00 description: "Personal web site and blog of digital director Jorgen Nilsson" license: "" licenseLink: "" sitelink: http://jorgennilsson.com/ tags: - personal - blog thumbnail: /img/jorgennilsson-tn.png title: jorgennilsson.com --- hugo-0.18.1/docs/content/showcase/kieranhealy.md000066400000000000000000000004501303124201100215610ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2014-02-27T20:35:00Z description: Kieran Healy's Website license: "" licenseLink: "" sitelink: http://kieranhealy.org/ sourceLink: https://github.com/kjhealy/kieranhealy.hugo tags: - personal - blog - academic thumbnail: /img/kjhealy-tn.jpg title: Kieran Healy --- hugo-0.18.1/docs/content/showcase/klingt-net.md000066400000000000000000000004651303124201100213470ustar00rootroot00000000000000--- date: 2016-05-15T23:18:16+02:00 description: "klingt.net is the personal homepage of Andreas Linz." license: "" licenseLink: "" sitelink: https://klingt.net/ sourceLink: https://github.com/klingtnet/klingt.net tags: - personal - blog - programming thumbnail: /img/klingt-net-tn.png title: klingt net --- hugo-0.18.1/docs/content/showcase/launchcode5.md000066400000000000000000000005531303124201100214630ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2014-11-01T07:32:00Z description: Corporate Site for Launchcode Software Studios license: Copyright Launchcode Software Studios licenseLink: "" sitelink: http://www.launchcode5.com/ sourceLink: https://github.com/Launchcode5/launchcode5.com tags: - bootstrap thumbnail: /img/launchcode-tn.jpg title: Launchcode Software Studios --- hugo-0.18.1/docs/content/showcase/leepenney.md000066400000000000000000000003521303124201100212520ustar00rootroot00000000000000--- lastmod: 2016-01-24 date: 2016-01-24T16:10:00Z description: Site of author Lee Penney license: MIT licenseLink: "" sitelink: http://leepenney.com/ tags: - personal - website thumbnail: /img/leepenney-tn.jpg title: Lee Penney --- hugo-0.18.1/docs/content/showcase/leowkahman.md000066400000000000000000000003531303124201100214150ustar00rootroot00000000000000--- date: 2016-07-24T00:00:00+08:00 description: "Leow Kah Man - Tech Blog" license: "" licenseLink: "" sitelink: https://www.leowkahman.com/ tags: - personal - blog thumbnail: /img/leowkahman-tn.png title: Leow Kah Man - Tech Blog ---hugo-0.18.1/docs/content/showcase/lk4d4.darth.io.md000066400000000000000000000004271303124201100217220ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-25T18:59:30-04:00 description: Alexandr Morozov license: "" licenseLink: "" sitelink: http://lk4d4.darth.io/ sourceLink: https://github.com/LK4D4/lk4d4.darth.io tags: - personal - blog thumbnail: /img/lk4d4-tn.jpg title: lk4d4.darth.io --- hugo-0.18.1/docs/content/showcase/losslesslife.md000066400000000000000000000006151303124201100217770ustar00rootroot00000000000000--- lastmod: 2015-11-15 date: 2015-11-15T11:20:00-08:00 description: "Losslesslife covers everything high-end and audiophile headphones. Headphones and headphone amplifiers, accessories, how-to guides, and reviews." sitelink: http://pages.losslesslife.com/ tags: - headphones - electronics - technical - reviews - education - audiophile thumbnail: /img/losslesslife-tn.png title: LosslessLife --- hugo-0.18.1/docs/content/showcase/mariosanchez.md000066400000000000000000000004041303124201100217470ustar00rootroot00000000000000--- lastmod: 2015-06-20 date: 2015-06-20 description: "" license: "" licenseLink: "" sitelink: http://mariosanchez.org/ sourceLink: https://github.com/mariobox/Hugo-Source tags: - personal - blog thumbnail: /img/mariosanchez-tn.jpg title: mariosanchez.org --- hugo-0.18.1/docs/content/showcase/mayan-edms.md000066400000000000000000000004571303124201100213270ustar00rootroot00000000000000--- date: 2016-06-13T19:38:56-04:00 description: "Free Open Source Document Management System" license: "Apache 2.0" licenseLink: "" sitelink: http://www.mayan-edms.com/ sourceLink: https://gitlab.com/mayan-edms/website tags: - paperless - floss thumbnail: /img/mayan-edms-tn.png title: Mayan EDMS --- hugo-0.18.1/docs/content/showcase/michaelwhatcott.md000066400000000000000000000004751303124201100224540ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-26T11:47:11-04:00 description: "" license: Simpl-2.0 licenseLink: "" sitelink: http://michaelwhatcott.com/ sourceLink: https://bitbucket.org/mdwhatcott/michaelwhatcott.com-boilerplate/src tags: - personal - blog thumbnail: /img/michaelwhatcott-tn.jpg title: michaelwhatcott --- hugo-0.18.1/docs/content/showcase/mongodb-eng-journal.md000066400000000000000000000004411303124201100231310ustar00rootroot00000000000000--- date: 2016-03-09T14:14:16-05:00 description: "The MongoDB Engineering Journal -- for builders, by builders." license: "" licenseLink: "" sitelink: http://engineering.mongodb.com/ tags: - engineering - blog thumbnail: /img/mongodb-eng-tn.png title: The Mongodb Engineering Journal --- hugo-0.18.1/docs/content/showcase/mtbhomer.md000066400000000000000000000004541303124201100211060ustar00rootroot00000000000000--- date: 2016-06-19T11:38:39+02:00 description: "Personal website Martijn ten Bhömer" license: "" licenseLink: "" sitelink: https://www.mtbhomer.com/ sourceLink: https://github.com/mtbhomer/web-portfolio tags: - personal - portfolio - design thumbnail: /img/mtbhomer-tn.png title: mtbhomer.com --- hugo-0.18.1/docs/content/showcase/nickoneill.md000066400000000000000000000004361303124201100214200ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-26T12:15:48-04:00 description: "" license: "" licenseLink: "" sitelink: http://blog.nickoneill.name/ sourceLink: https://github.com/nickoneill/blog.nickoneill.name tags: - personal - blog thumbnail: /img/nickoneill-tn.jpg title: authenticgeek --- hugo-0.18.1/docs/content/showcase/ninjaducks.in.md000066400000000000000000000004531303124201100220260ustar00rootroot00000000000000--- lastmod: 2015-10-24 date: 2015-10-24T14:06:00+05:30 description: Personal blog license: "" licenseLink: "" sitelink: http://ninjaducks.in sourceLink: https://github.com/shivanshuag/shivanshuag.github.io/tree/new tags: - personal - blog thumbnail: /img/ninjaducks-tn.png title: ninjaducks.in --- hugo-0.18.1/docs/content/showcase/ninya.io.md000066400000000000000000000004211303124201100210070ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-26T09:47:00-04:00 description: "" license: "" licenseLink: "" sitelink: http://blog.ninya.io/ sourceLink: https://github.com/ninya-io/ninya-io.github.io/tree/dev tags: - project - blog thumbnail: /img/ninya-tn.jpg title: ninya.io --- hugo-0.18.1/docs/content/showcase/nodesk.md000066400000000000000000000003171303124201100205520ustar00rootroot00000000000000--- lastmod: 2015-08-26 date: 2015-08-26T22:33:00Z description: "NoDesk | All Things Digital Nomad" sitelink: http://nodesk.co/ tags: - digital nomad - web thumbnail: /img/nodesk-tn.png title: nodesk.co --- hugo-0.18.1/docs/content/showcase/novelist-xyz.md000066400000000000000000000005001303124201100217540ustar00rootroot00000000000000--- date: 2016-05-22T17:54:51+08:00 description: "Peter Y. Chuang - Novelist, Short Story Writer" license: "" licenseLink: "" sitelink: https://novelist.xyz sourceLink: https://github.com/peterychuang/peterychuang.github.io/tree/source tags: - personal - blog thumbnail: /img/novelist-xyz.png title: Peter Y. Chuang --- hugo-0.18.1/docs/content/showcase/npf.md000066400000000000000000000003601303124201100200500ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2014-08-21T12:21:18-04:00 description: "" license: "" licenseLink: "" sitelink: http://npf.io/ sourceLink: https://github.com/natefinch/npf tags: - personal - blog thumbnail: /img/npf-tn.jpg title: npf.io --- hugo-0.18.1/docs/content/showcase/peteraba.md000066400000000000000000000004061303124201100210510ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-26T11:30:57-04:00 description: "" license: "" licenseLink: "" sitelink: https://peteraba.com/ sourceLink: https://github.com/peteraba/peteraba.com tags: - personal - blog thumbnail: /img/peteraba-tn.jpg title: peteraba --- hugo-0.18.1/docs/content/showcase/rahulrai.md000066400000000000000000000004131303124201100210730ustar00rootroot00000000000000--- date: 2016-10-04T21:01:18+01:00 description: "My Take on Cloud" license: "" licenseLink: "" sitelink: https://rahulrai.in sourceLink: https://github.com/moonytheloony/Blog-Web tags: - personal - blog thumbnail: /img/rahulrai_in-tn.png title: My Take on Cloud --- hugo-0.18.1/docs/content/showcase/rakutentech.md000066400000000000000000000003411303124201100216010ustar00rootroot00000000000000--- lastmod: 2016-01-20 date: 2016-01-20T07:32:00Z description: "" license: MIT licenseLink: "" sitelink: http://techblog.rakuten.co.jp/ tags: - company - blog thumbnail: /img/rakutentech-tn.png title: Rakuten Tech Blog --- hugo-0.18.1/docs/content/showcase/rdegges.md000066400000000000000000000004751303124201100207140ustar00rootroot00000000000000--- date: 2016-08-05T15:33:56-07:00 description: "The personal website of Randall Degges." license: "Unlicense" licenseLink: "http://unlicense.org/" sitelink: https://www.rdegges.com/ sourceLink: https://github.com/rdegges/rdegges-www tags: - personal - blog thumbnail: /img/rdegges-tn.png title: Randall Degges --- hugo-0.18.1/docs/content/showcase/readtext.md000066400000000000000000000003041303124201100211030ustar00rootroot00000000000000--- lastmod: 2015-11-16 date: 2015-11-16T08:36:00Z description: Restored text files sitelink: http://readtext.org/ tags: - textfiles - reading thumbnail: /img/readtext-tn.png title: ReadText --- hugo-0.18.1/docs/content/showcase/richardsumilang.md000066400000000000000000000006711303124201100224460ustar00rootroot00000000000000--- lastmod: 2015-09-08 date: 2015-09-07T00:12:00-07:00 description: "Personal website dedicated to electronics, programming, and reviews." license: "MIT" licenseLink: "https://opensource.org/licenses/MIT" sitelink: http://richardsumilang.com/ sourceLink: https://github.com/richardsumilang-blog tags: - personal - blog - technical - electronics - reviews thumbnail: /img/richardsumilang-tn.png title: Richard Sumilang - Top Secret Labs --- hugo-0.18.1/docs/content/showcase/rick-cogley-info.md000066400000000000000000000005261303124201100224320ustar00rootroot00000000000000--- lastmod: 2016-02-01 date: 2015-05-20T04:32:00Z description: Rick Cogley's personal site, powered by Hugo. license: MIT licenseLink: "" sitelink: http://rick.cogley.info/ sourceLink: https://github.com/RickCogley/RCC-Hugo2015 tags: - personal - blog - rickcogley - japan thumbnail: /img/rick_cogley_info-tn.jpg title: rick.cogley.info --- hugo-0.18.1/docs/content/showcase/ridingbytes.md000066400000000000000000000003731303124201100216140ustar00rootroot00000000000000--- lastmod: 2015-10-01 date: 2015-09-27T00:00:00Z description: Official Company Website license: "" licenseLink: "" sitelink: http://ridingbytes.com/ tags: - company - website - blog - tech thumbnail: /img/ridingbytes-tn.png title: RIDING BYTES --- hugo-0.18.1/docs/content/showcase/robertbasic.md000066400000000000000000000005151303124201100215660ustar00rootroot00000000000000--- lastmod: 2016-03-26 date: 2016-03-26T17:47:40+01:00 description: "Robert Basic is a web developer from Serbia." license: "" licenseLink: "" sitelink: http://robertbasic.com/ sourceLink: https://github.com/robertbasic/robertbasic.com-hugo tags: - personal - blog thumbnail: /img/robertbasic-tn.jpg title: Robert Basic's blog --- hugo-0.18.1/docs/content/showcase/scottcwilson.md000066400000000000000000000004721303124201100220240ustar00rootroot00000000000000--- lastmod: 2015-08-08 date: 2015-07-21T10:00:00Z description: Personal portfolio, created with Hugo license: MIT licenseLink: "" sitelink: http://scottcwilson.github.io/ sourceLink: https://github.com/scottcwilson/hugosite tags: - personal - blog thumbnail: /img/scottcwilson-tn.png title: scottcwilson.com --- hugo-0.18.1/docs/content/showcase/shapeshed.md000066400000000000000000000004011303124201100212250ustar00rootroot00000000000000--- date: 2016-10-10T07:32:00Z description: Personal blog. license: "" licenseLink: "" sitelink: http://shapeshed.com/ sourceLink: https://github.com/shapeshed/shapeshed.com tags: - personal - blog thumbnail: /img/shapeshed-tn.png title: shapeshed.com --- hugo-0.18.1/docs/content/showcase/shelan.md000066400000000000000000000004061303124201100205400ustar00rootroot00000000000000--- lastmod: 2016-02-07 date: 2016-02-07T10:30:00Z description: Shelan's Blog license: MIT licenseLink: "" sitelink: http://shelan.org/ sourceLink: https://github.com/shelan/my-hugo-site tags: - personal - blog thumbnail: /img/shelan-tn.png title: shelan.org ---hugo-0.18.1/docs/content/showcase/silvergeko.md000066400000000000000000000003461303124201100214430ustar00rootroot00000000000000--- date: 2016-03-28T14:16:59+02:00 description: "Custom theme of small italian software house" license: "" licenseLink: "" sitelink: http://silvergeko.it/ tags: - profesional thumbnail: /img/silvergeko.jpg title: Silvergeko --- hugo-0.18.1/docs/content/showcase/softinio.md000066400000000000000000000005621303124201100211230ustar00rootroot00000000000000--- lastmod: 2016-03-11 date: 2015-11-29T07:16:53-05:00 description: Salar Rahmanian Blog license: MIT licenseLink: https://raw.githubusercontent.com/softinio/softinio.com/master/LICENSE sitelink: http://www.softinio.com/ sourceLink: https://github.com/softinio/softinio.com tags: - personal - technical - blog thumbnail: /img/softinio-tn.png title: Salar Rahmanian --- hugo-0.18.1/docs/content/showcase/spf13.md000066400000000000000000000004231303124201100202210ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2013-07-01T07:32:00Z description: The first Hugo powered website. license: MIT licenseLink: "" sitelink: http://spf13.com/ sourceLink: https://github.com/spf13/spf13.com tags: - personal - blog thumbnail: /img/spf13-tn.jpg title: spf13.com --- hugo-0.18.1/docs/content/showcase/steambap.md000066400000000000000000000003671303124201100210700ustar00rootroot00000000000000--- date: 2016-07-28T07:32:00Z description: Weilin's blog license: MIT licenseLink: "" sitelink: http://weilinshi.org/ sourceLink: https://github.com/steambap/weilinshi.org tags: - personal - blog thumbnail: /img/steambap.png title: weilinshi --- hugo-0.18.1/docs/content/showcase/stefano.chiodino.md000066400000000000000000000004271303124201100225230ustar00rootroot00000000000000--- date: 2016-05-21T21:25:25+01:00 description: "Personal site + blog" license: "" licenseLink: "" sitelink: https://stefano.chiodino.uk/ sourceLink: https://github.com/Draga/go-web tags: - personal - blog thumbnail: /img/stefano.chiodino-tn.png title: stefano.chiodino.uk --- hugo-0.18.1/docs/content/showcase/stou.md000066400000000000000000000004131303124201100202560ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2014-11-23T01:28:16+07:00 description: "Rasmus Stougaard" license: "" licenseLink: "" sitelink: http://stou.dk/ sourceLink: "https://github.com/stou/stou.github.io" tags: - personal - blog thumbnail: /img/stou-tn.png title: stou.dk --- hugo-0.18.1/docs/content/showcase/szymonkatra.md000066400000000000000000000005151303124201100216510ustar00rootroot00000000000000--- lastmod: 2015-07-10 date: 2015-07-10T16:15:00+01:00 description: Szymon Katra license: "" licenseLink: "" sitelink: http://szymonkatra.github.io/ sourceLink: https://github.com/SzymonKatra/SzymonKatra.github.io/tree/master/hugo_project tags: - personal - blog thumbnail: /img/szymonkatra-tn.png title: szymonkatra.github.io --- hugo-0.18.1/docs/content/showcase/techmadeplain.md000066400000000000000000000003541303124201100220660ustar00rootroot00000000000000--- lastmod: 2015-01-27 date: 2014-05-22T19:54:00Z description: Tech Coaching site license: "" licenseLink: "" sitelink: http://techmadeplain.com/ tags: - personal - blog thumbnail: /img/techmadeplain-tn.jpg title: Tech Made Plain --- hugo-0.18.1/docs/content/showcase/tendermint.md000066400000000000000000000004151303124201100214370ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-26T09:34:42-04:00 description: "" license: "" licenseLink: "" sitelink: http://tendermint.com/ sourceLink: https://github.com/tendermint/tendermint.github.io tags: - project thumbnail: /img/tendermint-tn.jpg title: tendermint --- hugo-0.18.1/docs/content/showcase/thecodeking.md000066400000000000000000000003561303124201100215560ustar00rootroot00000000000000--- date: 2016-10-09T23:06:16+01:00 description: "Personal site for articles and projects." license: "" licenseLink: "" sitelink: http://thecodeking.co.uk tags: - personal - blog thumbnail: /img/thecodeking-tn.png title: thecodeking --- hugo-0.18.1/docs/content/showcase/thehome.md000066400000000000000000000004361303124201100207220ustar00rootroot00000000000000--- lastmod: 2015-08-08 date: 2014-12-27T20:00:00+07:00 description: "Tom Helmer Hansen" license: "" licenseLink: "" sitelink: http://www.thehome.dk/ sourceLink: "https://github.com/tomhelmer/website-source" tags: - personal - blog thumbnail: /img/thehome-tn.png title: thehome.dk --- hugo-0.18.1/docs/content/showcase/tutorialonfly.md000066400000000000000000000006431303124201100222040ustar00rootroot00000000000000--- lastmod: 2016-04-15 date: 2016-04-15T01:28:16+08:00 description: "Tutorialonfly.com provide free tutorials in gitbook version online and pdf,epub,mobi etc for offline read, it's a great website built on hugo, thanks spf13 who created hugo" license: "" licenseLink: "" sitelink: https://tutorialonfly.com/ tags: - tutorials - free - ebook download - fast thumbnail: /img/tutorialonfly-tn.jpg title: Tutorialonfly ---hugo-0.18.1/docs/content/showcase/ucsb.md000066400000000000000000000003711303124201100202230ustar00rootroot00000000000000--- lastmod: 2014-11-25 date: 2014-08-26T14:12:55-04:00 description: "" license: "" licenseLink: "" sitelink: http://philosophy.ucsb.edu/ sourceLink: https://github.com/ucsbphil/philweb tags: - education thumbnail: /img/ucsb-tn.jpg title: ucsb --- hugo-0.18.1/docs/content/showcase/upbeat.md000066400000000000000000000003231303124201100205440ustar00rootroot00000000000000--- date: 2016-06-12T11:57:53+02:00 description: "Blog by Rocchi Cesare" license: "" licenseLink: "" sitelink: http://upbeat.it/ sourceLink: tags: - personal - blog thumbnail: /img/upbeat.png title: upbeat --- hugo-0.18.1/docs/content/showcase/vamp.md000066400000000000000000000004411303124201100202300ustar00rootroot00000000000000--- lastmod: 2015-08-08 date: 2014-06-26T15:45:00Z description: Vamp.io microservices platform homepage and documentation license: "Apache 2" licenseLink: "" sitelink: http://vamp.io/ tags: - tech - documentation - company - api thumbnail: /img/vamp_landingpage-tn.png title: Vamp.io --- hugo-0.18.1/docs/content/showcase/viglug.org.md000066400000000000000000000004361303124201100213540ustar00rootroot00000000000000--- lastmod: 2016-03-01 date: 2016-03-01T11:20:00Z description: ViGLug.org is the website of the Linux User Group of Milan Est (Italy) license: "AGPLv3" licenseLink: "" sitelink: http://viglug.org/ tags: - tech - linux - user group thumbnail: /img/viglug-tn.png title: Viglug.org --- hugo-0.18.1/docs/content/showcase/vurt.co.md000066400000000000000000000003761303124201100206740ustar00rootroot00000000000000--- lastmod: 2014-08-26 date: 2014-08-26T12:09:39-04:00 description: "" license: "" licenseLink: "" sitelink: http://vurt.co.uk/ sourceLink: https://github.com/gilesp/vurtcouk tags: - personal - blog thumbnail: /img/vurt.co-tn.jpg title: vurt.co.uk --- hugo-0.18.1/docs/content/showcase/yslow-rules.md000066400000000000000000000006361303124201100216000ustar00rootroot00000000000000--- lastmod: 2015-08-08 date: 2014-04-07T10:45:00Z description: Community project of YSlow rules translations license: MIT License licenseLink: https://raw.github.com/checkmyws/yslow-rules/master/LICENSE sitelink: http://checkmyws.github.io/yslow-rules/ sourceLink: https://github.com/checkmyws/yslow-rules tags: - community - documentation - translation thumbnail: /img/yslow-rules-tn.png title: YSlow Rules --- hugo-0.18.1/docs/content/showcase/ysqi.md000066400000000000000000000004661303124201100202610ustar00rootroot00000000000000--- date: 2016-03-25T09:05:49+08:00 description: "虞双齐个人博客" license: "MIT" licenseLink: "https://opensource.org/licenses/MIT" sitelink: https://www.yushuangqi.com/ sourceLink: https://github.com/ysqi/yushuangqi.com/ tags: - personal - blog thumbnail: /img/ysqi-blog.png title: yushuangqi-blog --- hugo-0.18.1/docs/content/showcase/yulinling.net.md000066400000000000000000000005221303124201100220640ustar00rootroot00000000000000--- lastmod: 2015-12-19 date: 2015-09-09T21:42:00-04:00 description: Multilingual, blog license: "" licenseLink: "" sitelink: https://yulinling.net/ sourceLink: https://bitbucket.org/lynxiayel/yulinling_source_public tags: - blog - documentation thumbnail: /img/yulinling-tn.png title: 语林灵 (Yulinling) --- hugo-0.18.1/docs/content/taxonomies/000077500000000000000000000000001303124201100173165ustar00rootroot00000000000000hugo-0.18.1/docs/content/taxonomies/displaying.md000066400000000000000000000104321303124201100220030ustar00rootroot00000000000000--- aliases: - /indexes/displaying/ lastmod: 2016-06-29 date: 2013-07-01 linktitle: Displaying menu: main: parent: taxonomy next: /taxonomies/templates prev: /taxonomies/usage title: Displaying Taxonomies weight: 20 toc: true --- There are four common ways you can display the data in your taxonomies in addition to the automatic taxonomy pages created by hugo using the [list templates](/templates/list/): 1. For a given piece of content, you can list the terms attached 2. For a given piece of content, you can list other content with the same term 3. You can list all terms for a taxonomy 4. You can list all taxonomies (with their terms) ## 1. Displaying taxonomy terms assigned to this content Within your content templates, you may wish to display the taxonomies that that piece of content is assigned to. Because we are leveraging the front matter system to define taxonomies for content, the taxonomies assigned to each content piece are located in the usual place (.Params.`plural`). ### Example
    {{ range .Params.tags }}
  • {{ . }}
    • {{ end }}
If you want to list taxonomies inline, you will have to take care of optional plural ending in the title (if multiple taxonomies), as well as commas. Let's say we have a taxonomy "directors" such as `directors: [ "Joel Coen", "Ethan Coen" ]` in the TOML-format front matter. To list such taxonomy use the following: ### Example {{ if .Params.directors }} Director{{ if gt (len .Params.directors) 1 }}s{{ end }}: {{ range $index, $director := .Params.directors }}{{ if gt $index 0 }}, {{ end }}{{ . }}{{ end }} {{ end }} Alternatively, you may use the [delimit]({{< relref "templates/functions.md#delimit" >}}) template function as a shortcut if the taxonomies should just be listed with a separator. See {{< gh 2143 >}} on GitHub for discussion. ## 2. Listing content with the same taxonomy term First, you may be asking why you would use this. If you are using a taxonomy for something like a series of posts, this is exactly how you would do it. It’s also an quick and dirty way to show some related content. ### Example ## 3. Listing all content in a given taxonomy This would be very useful in a sidebar as “featured content”. You could even have different sections of “featured content” by assigning different terms to the content. ### Example ## 4. Rendering a Site's Taxonomies If you wish to display the list of all keys for a taxonomy, you can find retrieve them from the `.Site` variable which is available on every page. This may take the form of a tag cloud, a menu or simply a list. The following example displays all tag keys: ### Example
    {{ range $name, $taxonomy := .Site.Taxonomies.tags }}
  • {{ $name }}
    • {{ end }}
### Complete Example This example will list all taxonomies, each of their keys and all the content assigned to each key.
    {{ range $taxonomyname, $taxonomy := .Site.Taxonomies }}
  • {{ $taxonomyname }}
      {{ range $key, $value := $taxonomy }}
    • {{ $key }}
      • {{ end }}
    • {{ end }}
hugo-0.18.1/docs/content/taxonomies/methods.md000066400000000000000000000025341303124201100213070ustar00rootroot00000000000000--- lastmod: 2015-12-23 date: 2014-05-26 linktitle: Structure & Methods menu: main: parent: taxonomy next: /extras/aliases prev: /taxonomies/ordering title: Using Taxonomies weight: 75 --- Hugo makes a set of values and methods available on the various Taxonomy structures. ## Taxonomy Methods A Taxonomy is a `map[string]WeightedPages`. .Get(term) : Returns the WeightedPages for a term. .Count(term) : The number of pieces of content assigned to this term. .Alphabetical : Returns an OrderedTaxonomy (slice) ordered by Term. .ByCount : Returns an OrderedTaxonomy (slice) ordered by number of entries. ## OrderedTaxonomy Since Maps are unordered, an OrderedTaxonomy is a special structure that has a defined order. ```go []struct { Name string WeightedPages WeightedPages } ``` Each element of the slice has: .Term : The Term used. .WeightedPages : A slice of Weighted Pages. .Count : The number of pieces of content assigned to this term. .Pages : All Pages assigned to this term. All [list methods](/templates/list/) are available to this. ## WeightedPages WeightedPages is simply a slice of WeightedPage. ```go type WeightedPages []WeightedPage ``` .Count(term) : The number of pieces of content assigned to this term. .Pages : Returns a slice of pages, which then can be ordered using any of the [list methods](/templates/list/). hugo-0.18.1/docs/content/taxonomies/ordering.md000066400000000000000000000046311303124201100214550ustar00rootroot00000000000000--- aliases: - /indexes/ordering/ lastmod: 2015-12-23 date: 2013-07-01 linktitle: Ordering menu: main: identifier: Ordering Taxonomies parent: taxonomy next: /taxonomies/methods prev: /taxonomies/templates title: Ordering Taxonomies weight: 60 toc: true --- Hugo provides the ability to both: 1. Order the way the keys for a taxonomy are displayed 2. Order the way taxonomyed content appears ## Ordering Taxonomies Taxonomies can be ordered by either alphabetical key or by the number of content pieces assigned to that key. ### Order Alphabetically Example
    {{ $data := .Data }} {{ range $key, $value := .Data.Taxonomy.Alphabetical }}
  • {{ $value.Name }} {{ $value.Count }}
    • {{ end }}
### Order by Popularity Example
    {{ $data := .Data }} {{ range $key, $value := .Data.Taxonomy.ByCount }}
  • {{ $value.Name }} {{ $value.Count }}
    • {{ end }}
[See Also Taxonomy Lists]({{< relref "templates/list.md" >}}) ## Ordering Content within Taxonomies Hugo uses both **Date** and **Weight** to order content within taxonomies. Each piece of content in Hugo can optionally be assigned a date. It can also be assigned a weight for each taxonomy it is assigned to. When iterating over content within taxonomies the default sort is first by weight then by date. This means that if the weights for two pieces of content are the same, than the more recent content will be displayed first. The default weight for any piece of content is 0. ### Assigning Weight Content can be assigned weight for each taxonomy that it's assigned to. ```toml +++ tags = [ "a", "b", "c" ] tags_weight = 22 categories = ["d"] title = "foo" categories_weight = 44 +++ Front Matter with weighted tags and categories ``` The convention is `taxonomyname_weight`. In the above example, this piece of content has a weight of 22 which applies to the sorting when rendering the pages assigned to the "a", "b" and "c" values of the 'tag' taxonomy. It has also been assigned the weight of 44 when rendering the 'd' category. With this the same piece of content can appear in different positions in different taxonomies. Currently taxonomies only support the default ordering of content which is weight -> date. hugo-0.18.1/docs/content/taxonomies/overview.md000066400000000000000000000055601303124201100215140ustar00rootroot00000000000000--- aliases: - /indexes/overview/ - /doc/indexes/ - /extras/indexes lastmod: 2015-08-04 date: 2013-07-01 linktitle: Overview menu: main: identifier: taxonomy overview parent: taxonomy next: /taxonomies/usage prev: /templates/404 title: Taxonomy Overview weight: 10 --- Hugo includes support for user-defined groupings of content called taxonomies.[^1] Taxonomies give us a way to classify our content so we can demonstrate relationships in a variety of logical ways. [^1]: Taxonomies were called *indexes* in Hugo prior to v0.11. The default taxonomies for Hugo are *tags* and *categories*. These taxonomies are common to many website systems (e.g. WordPress, Drupal, Jekyll). Unlike all of those systems, Hugo makes it trivial to customize the taxonomies you will be using for your site however you wish. Another good use for taxonomies is to group a set of posts into a series. Other common uses would include *categories*, *tags*, *groups*, *series* and many more. When taxonomies are used (and templates are provided), Hugo will automatically create pages listing all of the taxonomies, their terms and all of the content attached to those terms. ## Definitions **Taxonomy:** A categorization that can be used to classify content **Term:** A key within that taxonomy **Value:** A piece of content assigned to that Term ## Example For example, if I was writing about movies, I may want the following taxonomies: * Actors * Directors * Studios * Genre * Year * Awards I would then specify in each movie’s front-matter the specific terms for each of those taxonomies. Hugo would then automatically create pages for each Actor, Director, Studio, Genre, Year and Award listing all of the Movies that matched that specific Actor, Director, etc. ### Taxonomy Organization Let’s use an example to demonstrate the different labels in action. From the perspective of the taxonomy, it could be visualized as: Actor <- Taxonomy Bruce Willis <- Term The Six Sense <- Content Unbreakable <- Content Moonrise Kingdom <- Content Samuel L. Jackson <- Term Unbreakable <- Content The Avengers <- Content xXx <- Content From the perspective of the content, it would appear differently, though the data and labels used are the same: Unbreakable <- Content Actors <- Taxonomy Bruce Willis <- Term Samuel L. Jackson <- Term Director <- Taxonomy M. Night Shyamalan <- Term ... Moonrise Kingdom <- Content Actors <- Taxonomy Bruce Willis <- Term Bill Murray <- Term Director <- Taxonomy Wes Anderson <- Term ... hugo-0.18.1/docs/content/taxonomies/templates.md000066400000000000000000000013131303124201100216340ustar00rootroot00000000000000--- aliases: - /indexes/templates/ lastmod: 2014-05-29 date: 2013-07-01 linktitle: Templates menu: main: parent: taxonomy next: /taxonomies/ordering prev: /templates/displaying title: Taxonomy Templates weight: 30 --- There are two different templates that the use of taxonomies will require you to provide. Both templates are covered in detail in the templates section. A [list template](/templates/list/) is any template that will be used to render multiple pieces of content in a single html page. This template will be used to generate all the automatically created taxonomy pages. A [taxonomy terms template](/templates/terms/) is a template used to generate the list of terms for a given template. hugo-0.18.1/docs/content/taxonomies/usage.md000066400000000000000000000057151303124201100207540ustar00rootroot00000000000000--- lastmod: 2015-12-23 date: 2014-05-26 linktitle: Usage toc: true menu: main: parent: taxonomy next: /taxonomies/displaying prev: /taxonomies/overview title: Using Taxonomies weight: 15 --- ## Defining taxonomies for a site Taxonomies must be defined in the site configuration before they can be used throughout the site. You need to provide both the plural and singular labels for each taxonomy. Here is an example configuration in TOML and YAML that specifies three taxonomies (the default two, plus `series`). Notice the format is singular key = "plural value" for TOML, or singular key: "plural value" for YAML:
config.toml excerpt:config.yaml excerpt: 
[taxonomies]
tag = "tags"
category = "categories"
series = "series"

taxonomies:
  tag: "tags"
  category: "categories"
  series: "series"
## Assigning taxonomy values to content Once an taxonomy is defined at the site level, any piece of content can be assigned to it regardless of content type or section. Assigning content to an taxonomy is done in the front matter. Simply create a variable with the *plural* name of the taxonomy and assign all terms you want to apply to this content. ## Preserving taxonomy values By default, taxonomy names are hyphenated, lower-cased and normalized, and then fixed and titleized on the archive page. However, if you want to have a taxonomy value with special characters such as `Gérard Depardieu` instead of `Gerard Depardieu`, you need to set the `preserveTaxonomyNames` [site configuration](/overview/configuration/) variable to `true`. Hugo will then preserve special characters in taxonomy values but will still titleize the values for titles and normalize them in URLs. Note that if you use `preserveTaxonomyNames` and intend to manually construct URLs to the archive pages, you will need to pass the taxonomy values through the `urlize` template function. ## Front Matter Example (in TOML) ```toml +++ title = "Hugo: A fast and flexible static site generator" tags = [ "Development", "Go", "fast", "Blogging" ] categories = [ "Development" ] series = [ "Go Web Dev" ] slug = "hugo" project_url = "https://github.com/spf13/hugo" +++ ``` ## Front Matter Example (in JSON) ```json { "title": "Hugo: A fast and flexible static site generator", "tags": [ "Development", "Go", "fast", "Blogging" ], "categories" : [ "Development" ], "series" : [ "Go Web Dev" ], "slug": "hugo", "project_url": "https://github.com/spf13/hugo" } ``` ## Add content file with frontmatter See [Source Organization]({{< relref "overview/source-directory.md#content-for-home-page-and-other-list-pages" >}}). hugo-0.18.1/docs/content/templates/000077500000000000000000000000001303124201100171265ustar00rootroot00000000000000hugo-0.18.1/docs/content/templates/404.md000066400000000000000000000033361303124201100177640ustar00rootroot00000000000000--- aliases: - /layout/404/ lastmod: 2015-12-30 date: 2013-08-21 linktitle: "Custom 404 page" menu: main: parent: layout next: /taxonomies/overview notoc: true next: /templates/debugging prev: /templates/sitemap title: 404.html Templates weight: 100 --- When using Hugo with [GitHub Pages](http://pages.github.com/), you can provide your own template for a [custom 404 error page](https://help.github.com/articles/custom-404-pages/) by creating a 404.html template file in your `/layouts` folder. When Hugo generates your site, the `404.html` file will be placed in the root. 404 pages will have all the regular [page variables](/layout/variables/) available to use in the templates. In addition to the standard page variables, the 404 page has access to all site content accessible from `.Data.Pages`. ▾ layouts/ 404.html ## 404.html This is a basic example of a 404.html template: {{ partial "header.html" . }} {{ partial "subheader.html" . }}

{{ .Title }}

{{ partial "footer.html" . }} ### Automatic Loading Your 404.html file can be set to load automatically when a visitor enters a mistaken URL path, dependent upon the web serving environment you are using. For example: * _GitHub Pages_ - it's automatic. * _Apache_ - one way is to specify `ErrorDocument 404 /404.html` in an `.htaccess` file in the root of your site. * _Nginx_ - you might specify `error_page 404 = /404.html;` in your `nginx.conf` file. * _Amazon AWS S3_ - when setting a bucket up for static web serving, you can specify the error file. * _Caddy Server_ - using `errors { 404 /404.html }`. [Details here](https://caddyserver.com/docs/errors) hugo-0.18.1/docs/content/templates/ace.md000066400000000000000000000037761303124201100202150ustar00rootroot00000000000000--- aliases: - /doc/templates/ace - /layout/templates/ace - /layout/ace/ lastmod: 2015-08-04 date: 2014-04-20 linktitle: Ace templates menu: main: parent: layout next: /templates/functions prev: /templates/go-templates title: Ace Templates weight: 17 --- In addition to [Go templates](/templates/go-templates) and [Amber](/templates/amber) templates, Hugo supports the powerful Ace templates. For template documentation, follow the links from the [Ace project](https://github.com/yosssi/ace). * Ace templates must be named with the ace-suffix, e.g. `list.ace` * It's possible to use both Go templates and Ace templates side-by-side, and include one into the other * Full Go template syntax support, including all the useful helper funcs * Partials can be included both with the Ace and the Go template syntax: * `= include partials/foo.html .`[^ace-theme] * `{{ partial "foo" . }}` One noticeable difference between Ace and the others is the inheritance support through [base and inner templates](https://github.com/yosssi/ace/tree/master/examples/base_inner_template). In Hugo the base template will be chosen with the same ruleset as for [Go templates](/templates/blocks/). .: index.ace ./blog: single.ace baseof.ace ./_default: baseof.ace list.ace single.ace single-baseof.ace ``` Some examples for the layout files above: * Home page: `./index.ace` + `./_default/baseof.ace` * Single page in the `blog` section: `./blog/single.ace` + `./blog/baseof.ace` * Single page in another section: `./_default/single.ace` + `./_default/single-baseof.ace` * Taxonomy page in any section: `./_default/list.ace` + `./_default/baseof.ace` **Note:** In most cases one `baseof.ace` in `_default` will suffice. **Note:** An Ace template without a reference to a base section, e.g. `= content`, will be handled as a standalone template. [^ace-theme]: Note that the `html` suffix is needed, even if the filename is suffixed `ace`. This does not work from inside a theme, see [issue 763](https://github.com/spf13/hugo/issues/763). hugo-0.18.1/docs/content/templates/amber.md000066400000000000000000000014201303124201100205330ustar00rootroot00000000000000--- aliases: - /doc/templates/amber - /layout/templates/amber - /layout/amber/ lastmod: 2015-11-05 date: 2015-07-20 linktitle: Amber templates menu: main: parent: layout next: /templates/functions prev: /templates/go-templates title: Amber Templates weight: 18 --- Amber templates are another template type which Hugo supports, in addition to [Go templates](/templates/go-templates) and [Ace templates]({{< relref "templates/ace.md" >}}) templates. For template documentation, follow the links from the [Amber project](https://github.com/eknkc/amber) * Amber templates must be named with the amber-suffix, e.g. `list.amber` * Partials in Amber or HTML can be included with the Amber template syntax: * `import ../partials/test.html ` * `import ../partials/test_a.amber ` hugo-0.18.1/docs/content/templates/blocks.md000066400000000000000000000061661303124201100207360ustar00rootroot00000000000000--- date: 2016-03-29T21:26:20-05:00 menu: main: parent: layout prev: /templates/views/ next: /templates/partials/ title: Block Templates weight: 80 --- Go 1.6 includes a powerful new keyword, `block`. This construct allows you to define the outer shell of your pages one ore more master template(s), filling in or overriding portions as necessary. ## Base template lookup This is the order Hugo searches for a base template: 1. /layouts/_current-path_/_template-name_-baseof.html, e.g. list-baseof.html. 2. /layouts/_current-path_/baseof.html 3. /layouts/_default/_template-name_-baseof.html e.g. list-baseof.html. 4. /layouts/_default/baseof.html For each of the steps above, it will first look in the project, then, if theme is set, in the theme's layouts folder. Hugo picks the first base template found. As an example, with a site using the theme `exampletheme`, when rendering the section list for the section `post`. Hugo picks the `section/post.html` as the template and this template has a `define` section that indicates it needs a base template. This is then the lookup order: 1. `/layouts/section/post-baseof.html` 2. `/themes/exampletheme/layouts/section/post-baseof.html` 3. `/layouts/section/baseof.html` 4. `/themes/exampletheme/layouts/section/baseof.html` 5. `/layouts/_default/post-baseof.html` 6. `/themes/exampletheme/layouts/_default/post-baseof.html` 7. `/layouts/_default/baseof.html` 8. `/themes/exampletheme/layouts/_default/baseof.html` ## Define the base template Let's define a simple base template (`_default/baseof.html`), a shell from which all our pages will start. ```html {{ block "title" . }} <!-- Blocks may include default content. --> {{ .Site.Title }} {{ end }} {{ block "main" . }} {{ end }} ``` ## Overriding the base Your [default list template]({{< relref "templates/list.md" >}}) (`_default/list.html`) will inherit all of the code defined in the base template. It could then implement its own "main" block from the base template above like so: ```html {{ define "main" }}

Posts

{{ range .Data.Pages }}

{{ .Title }}

{{ .Content }}
{{ end }} {{ end }} ``` This replaces the contents of our (basically empty) "main" block with something useful for the list template. In this case, we didn't define a "title" block so the contents from our base template remain unchanged in lists. In our [default single template]({{< relref "templates/content.md" >}}) (`_default/single.html`), let's implement both blocks: ```html {{ define "title" }} {{ .Title }} – {{ .Site.Title }} {{ end }} {{ define "main" }}

{{ .Title }}

{{ .Content }} {{ end }} ``` This overrides both block areas from the base template with code unique to our single template. hugo-0.18.1/docs/content/templates/content.md000066400000000000000000000117121303124201100211240ustar00rootroot00000000000000--- aliases: - /layout/content/ lastmod: 2015-05-22 date: 2013-07-01 linktitle: Single Content menu: main: parent: layout next: /templates/list prev: /templates/variables title: Single Content Template weight: 30 toc: true --- The primary view of content in Hugo is the single view. Hugo, for every Markdown file provided, will render it with a single template. ## Which Template will be rendered? Hugo uses a set of rules to figure out which template to use when rendering a specific page. Hugo will use the following prioritized list. If a file isn’t present, then the next one in the list will be used. This enables you to craft specific layouts when you want to without creating more templates than necessary. For most sites, only the `_default` file at the end of the list will be needed. Users can specify the `type` and `layout` in the [front-matter](/content/front-matter/). `Section` is determined based on the content file’s location. If `type` is provided, it will be used instead of `section`. ### Single Page * /layouts/`TYPE`/`LAYOUT`.html * /layouts/`SECTION`/`LAYOUT`.html * /layouts/`TYPE`/single.html * /layouts/`SECTION`/single.html * /layouts/_default/single.html * /themes/`THEME`/layouts/`TYPE`/`LAYOUT`.html * /themes/`THEME`/layouts/`SECTION`/`LAYOUT`.html * /themes/`THEME`/layouts/`TYPE`/single.html * /themes/`THEME`/layouts/`SECTION`/single.html * /themes/`THEME`/layouts/_default/single.html ## Example Single Template File Content pages are of the type "page" and have all the [page variables](/layout/variables/) and [site variables](/templates/variables/) available to use in the templates. In the following examples we have created two different content types as well as a default content type. The default content template to be used in the event that a specific template has not been provided for that type. The default type works the same as the other types, but the directory must be called "\_default". ▾ layouts/ ▾ _default/ single.html ▾ post/ single.html ▾ project/ single.html ### post/single.html This content template is used for [spf13.com](http://spf13.com/). It makes use of [partial templates](/templates/partials/) {{ partial "header.html" . }} {{ partial "subheader.html" . }} {{ $baseURL := .Site.BaseURL }}

{{ .Title }}

{{ .Content }}
{{ partial "disqus.html" . }} {{ partial "footer.html" . }} ### project/single.html This content template is used for [spf13.com](http://spf13.com/). It makes use of [partial templates](/templates/partials/) {{ partial "header.html" . }} {{ partial "subheader.html" . }} {{ $baseURL := .Site.BaseURL }}

{{ .Title }}

{{ .Content }}
{{if isset .Params "project_url" }} {{ end }} {{ partial "footer.html" . }} Notice how the project/single.html template uses an additional parameter unique to this template. This doesn't need to be defined ahead of time. If the key is present in the front matter than it can be used in the template. To easily generate new content of this type with these keys ready use [content archetypes](/content/archetypes/). hugo-0.18.1/docs/content/templates/debugging.md000066400000000000000000000027211303124201100214050ustar00rootroot00000000000000--- aliases: - /doc/debugging/ - /layout/debugging/ lastmod: 2015-05-25 date: 2015-05-22 linktitle: Debugging menu: main: parent: layout prev: /templates/404 title: Template Debugging weight: 110 --- # Template Debugging Here are some snippets you can add to your template to answer some common questions. These snippets use the `printf` function available in all Go templates. This function is an alias to the Go function, [fmt.Printf](http://golang.org/pkg/fmt/). ### What variables are available in this context? You can use the template syntax, `$.`, to get the top-level template context from anywhere in your template. This will print out all the values under, `.Site`. {{ printf "%#v" $.Site }} This will print out the value of `.Permalink`: {{ printf "%#v" .Permalink }} This will print out a list of all the variables scoped to the current context (a.k.a. The dot, "`.`"). {{ printf "%#v" . }} When writing a [Homepage](/templates/homepage), what does one of the pages you're looping through look like? ``` {{ range .Data.Pages }} {{/* The context, ".", is now a Page */}} {{ printf "%#v" . }} {{ end }} ``` ### Why do I have no variables defined? Check that you are passing variables in the `partial` function. For example ``` {{ partial "header" }} ``` will render the header partial, but the header partial will not have access to any variables. You need to pass variables explicitly. For example: ``` {{ partial "header" . }} ``` hugo-0.18.1/docs/content/templates/functions.md000066400000000000000000001015331303124201100214630ustar00rootroot00000000000000--- aliases: - /layout/functions/ lastmod: 2015-09-20 date: 2013-07-01 linktitle: Functions toc: true menu: main: parent: layout next: /templates/variables prev: /templates/go-templates title: Hugo Template Functions weight: 20 --- Hugo uses the excellent Go html/template library for its template engine. It is an extremely lightweight engine that provides a very small amount of logic. In our experience, it is just the right amount of logic to be able to create a good static website. Go templates are lightweight but extensible. Hugo has added the following functions to the basic template logic. (Go itself supplies built-in functions, including comparison operators and other basic tools; these are listed in the [Go template documentation](http://golang.org/pkg/text/template/#hdr-Functions).) ## General ### default Checks whether a given value is set and returns a default value if it is not. "Set" in this context means non-zero for numeric types and times; non-zero length for strings, arrays, slices, and maps; any boolean or struct value; or non-nil for any other types. e.g. {{ index .Params "font" | default "Roboto" }} → default is "Roboto" {{ default "Roboto" (index .Params "font") }} → default is "Roboto" ### delimit Loops through any array, slice or map and returns a string of all the values separated by the delimiter. There is an optional third parameter that lets you choose a different delimiter to go between the last two values. Maps will be sorted by the keys, and only a slice of the values will be returned, keeping a consistent output order. Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) e.g. // Front matter +++ tags: [ "tag1", "tag2", "tag3" ] +++ // Used anywhere in a template Tags: {{ delimit .Params.tags ", " }} // Outputs Tags: tag1, tag2, tag3 // Example with the optional "last" parameter Tags: {{ delimit .Params.tags ", " " and " }} // Outputs Tags: tag1, tag2 and tag3 ### dict Creates a dictionary `(map[string, interface{})`, expects parameters added in value:object fasion. Invalid combinations like keys that are not strings or uneven number of parameters, will result in an exception thrown. Useful for passing maps to partials when adding to a template. e.g. Pass into "foo.html" a map with the keys "important, content" {{$important := .Site.Params.SomethingImportant }} {{range .Site.Params.Bar}} {{partial "foo" (dict "content" . "important" $important)}} {{end}} "foo.html" Important {{.important}} {{.content}} or create a map on the fly to pass into {{partial "foo" (dict "important" "Smiles" "content" "You should do more")}} ### slice `slice` allows you to create an array (`[]interface{}`) of all arguments that you pass to this function. One use case is the concatenation of elements in combination with `delimit`: ```html {{ delimit (slice "foo" "bar" "buzz") ", " }} ``` ### shuffle `shuffle` returns a random permutation of a given array or slice, e.g. ```html {{ shuffle (seq 1 5) }} {{ shuffle (slice "foo" "bar" "buzz") }} ``` ### echoParam Prints a parameter if it is set. e.g. `{{ echoParam .Params "project_url" }}` ### eq Returns true if the parameters are equal. e.g. {{ if eq .Section "blog" }}current{{ end }} ### first Slices an array to only the first _N_ elements. Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) e.g. {{ range first 10 .Data.Pages }} {{ .Render "summary" }} {{ end }} ### jsonify Encodes a given object to JSON. e.g. {{ dict "title" .Title "content" .Plain | jsonify }} ### last Slices an array to only the last _N_ elements. Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) e.g. {{ range last 10 .Data.Pages }} {{ .Render "summary" }} {{ end }} ### after Slices an array to only the items after the Nth item. Use this in combination with `first` to use both halves of an array split at item _N_. Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) e.g. {{ range after 10 .Data.Pages }} {{ .Render "title" }} {{ end }} ### getenv Returns the value of an environment variable. Takes a string containing the name of the variable as input. Returns an empty string if the variable is not set, otherwise returns the value of the variable. Note that in Unix-like environments, the variable must also be exported in order to be seen by `hugo`. e.g. {{ getenv "HOME" }} ### in Checks if an element is in an array (or slice) and returns a boolean. The elements supported are strings, integers and floats (only float64 will match as expected). In addition, it can also check if a substring exists in a string. e.g. {{ if in .Params.tags "Git" }}Follow me on GitHub!{{ end }} or {{ if in "this string contains a substring" "substring" }}Substring found!{{ end }} ### intersect Given two arrays (or slices), this function will return the common elements in the arrays. The elements supported are strings, integers and floats (only float64). A useful example of this functionality is a 'similar posts' block. Create a list of links to posts where any of the tags in the current post match any tags in other posts. e.g.
    {{ $page_link := .Permalink }} {{ $tags := .Params.tags }} {{ range .Site.Pages }} {{ $page := . }} {{ $has_common_tags := intersect $tags .Params.tags | len | lt 0 }} {{ if and $has_common_tags (ne $page_link $page.Permalink) }}
  • {{ $page.Title }}
    • {{ end }} {{ end }}
### isset Returns true if the parameter is set. Takes either a slice, array or channel and an index or a map and a key as input. e.g. `{{ if isset .Params "project_url" }} {{ index .Params "project_url" }}{{ end }}` ### seq Creates a sequence of integers. It's named and used as GNU's seq. Some examples: * `3` => `1, 2, 3` * `1 2 4` => `1, 3` * `-3` => `-1, -2, -3` * `1 4` => `1, 2, 3, 4` * `1 -2` => `1, 0, -1, -2` ### sort Sorts maps, arrays and slices, returning a sorted slice. A sorted array of map values will be returned, with the keys eliminated. There are two optional arguments, which are `sortByField` and `sortAsc`. If left blank, sort will sort by keys (for maps) in ascending order. Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) e.g. // Front matter +++ tags: [ "tag3", "tag1", "tag2" ] +++ // Site config +++ [params.authors] [params.authors.Derek] "firstName" = "Derek" "lastName" = "Perkins" [params.authors.Joe] "firstName" = "Joe" "lastName" = "Bergevin" [params.authors.Tanner] "firstName" = "Tanner" "lastName" = "Linsley" +++ // Use default sort options - sort by key / ascending Tags: {{ range sort .Params.tags }}{{ . }} {{ end }} // Outputs Tags: tag1 tag2 tag3 // Sort by value / descending Tags: {{ range sort .Params.tags "value" "desc" }}{{ . }} {{ end }} // Outputs Tags: tag3 tag2 tag1 // Use default sort options - sort by value / descending Authors: {{ range sort .Site.Params.authors }}{{ .firstName }} {{ end }} // Outputs Authors: Derek Joe Tanner // Use default sort options - sort by value / descending Authors: {{ range sort .Site.Params.authors "lastName" "desc" }}{{ .lastName }} {{ end }} // Outputs Authors: Perkins Linsley Bergevin ### where Filters an array to only elements containing a matching value for a given field. Works on [lists](/templates/list/), [taxonomies](/taxonomies/displaying/), [terms](/templates/terms/), [groups](/templates/list/) e.g. {{ range where .Data.Pages "Section" "post" }} {{ .Content }} {{ end }} It can be used with dot chaining second argument to refer a nested element of a value. e.g. // Front matter on some pages +++ series: golang +++ {{ range where .Site.Pages "Params.series" "golang" }} {{ .Content }} {{ end }} It can also be used with an operator like `!=`, `>=`, `in` etc. Without an operator (like above), `where` compares a given field with a matching value in a way like `=` is specified. e.g. {{ range where .Data.Pages "Section" "!=" "post" }} {{ .Content }} {{ end }} Following operators are now available - `=`, `==`, `eq`: True if a given field value equals a matching value - `!=`, `<>`, `ne`: True if a given field value doesn't equal a matching value - `>=`, `ge`: True if a given field value is greater than or equal to a matching value - `>`, `gt`: True if a given field value is greater than a matching value - `<=`, `le`: True if a given field value is lesser than or equal to a matching value - `<`, `lt`: True if a given field value is lesser than a matching value - `in`: True if a given field value is included in a matching value. A matching value must be an array or a slice - `not in`: True if a given field value isn't included in a matching value. A matching value must be an array or a slice - `intersect`: True if a given field value that is a slice / array of strings or integers contains elements in common with the matching value. It follows the same rules as the intersect function. *`intersect` operator, e.g.:* {{ range where .Site.Pages ".Params.tags" "intersect" .Params.tags }} {{ if ne .Permalink $.Permalink }} {{ .Render "summary" }} {{ end }} {{ end }} *`where` and `first` can be stacked, e.g.:* {{ range first 5 (where .Data.Pages "Section" "post") }} {{ .Content }} {{ end }} ### Unset field Filter only work for set fields. To check whether a field is set or exist, use operand `nil`. This can be useful to filter a small amount of pages from a large pool. Instead of set field on all pages, you can set field on required pages only. Only following operators are available for `nil` - `=`, `==`, `eq`: True if the given field is not set. - `!=`, `<>`, `ne`: True if the given field is set. e.g. {{ range where .Data.Pages ".Params.specialpost" "!=" nil }} {{ .Content }} {{ end }} ## Files ### readDir Gets a directory listing from a directory relative to the current project working dir. So, If the project working dir has a single file named `README.txt`: `{{ range (readDir ".") }}{{ .Name }}{{ end }}` → "README.txt" ### readFile Reads a file from disk and converts it into a string. Note that the filename must be relative to the current project working dir. So, if you have a file with the name `README.txt` in the root of your project with the content `Hugo Rocks!`: `{{readFile "README.txt"}}` → `"Hugo Rocks!"` ### imageConfig Parses the image and returns the height, width and color model. e.g. ``` {{ with (imageConfig "favicon.ico") }} favicon.ico: {{.Width}} x {{.Height}} {{ end }} ``` ## Math
Function Description Example
add Adds two integers. {{add 1 2}} → 3
div Divides two integers. {{div 6 3}} → 2
mod Modulus of two integers. {{mod 15 3}} → 0
modBool Boolean of modulus of two integers. true if modulus is 0. {{modBool 15 3}} → true
mul Multiplies two integers. {{mul 2 3}} → 6
sub Subtracts two integers. {{sub 3 2}} → 1
## Numbers ### int Creates an `int`. e.g. * `{{ int "123" }}` → 123 ## Strings ### printf Format a string using the standard `fmt.Sprintf` function. See [the go doc](https://golang.org/pkg/fmt/) for reference. A e.g., `{{ i18n ( printf "combined_%s" $var ) }}` or `{{ printf "formatted %.2f" 3.1416 }}` ### chomp Removes any trailing newline characters. Useful in a pipeline to remove newlines added by other processing (including `markdownify`). e.g., `{{chomp "

Blockhead

\n"}}` → `"

Blockhead

"` ### dateFormat Converts the textual representation of the datetime into the other form or returns it of Go `time.Time` type value. These are formatted with the layout string. e.g. `{{ dateFormat "Monday, Jan 2, 2006" "2015-01-21" }}` → "Wednesday, Jan 21, 2015" ### emojify Runs the string through the Emoji emoticons processor. The result will be declared as "safe" so Go templates will not filter it. See the [Emoji cheat sheet](http://www.emoji-cheat-sheet.com/) for available emoticons. e.g. `{{ "I :heart: Hugo" | emojify }}` ### highlight Takes a string of code and a language, uses Pygments to return the syntax highlighted code in HTML. Used in the [highlight shortcode](/extras/highlighting/). ### htmlEscape HtmlEscape returns the given string with the critical reserved HTML codes escaped, such that `&` becomes `&` and so on. It escapes only: `<`, `>`, `&`, `'` and `"`. Bear in mind that, unless content is passed to `safeHTML`, output strings are escaped usually by the processor anyway. e.g. `{{ htmlEscape "Hugo & Caddy > Wordpress & Apache" }} → "Hugo & Caddy > Wordpress & Apache"` ### htmlUnescape HtmlUnescape returns the given string with html escape codes un-escaped. This un-escapes more codes than `htmlEscape` escapes, including `#` codes and pre-UTF8 escapes for accented characters. It defers completely to the Go `html.UnescapeString` function, so functionality is consistent with that codebase. Remember to pass the output of this to `safeHTML` if fully unescaped characters are desired, or the output will be escaped again as normal. e.g. `{{ htmlUnescape "Hugo & Caddy > Wordpress & Apache" }} → "Hugo & Caddy > Wordpress & Apache"` ### humanize Humanize returns the humanized version of an argument with the first letter capitalized. If the input is either an int64 value or the string representation of an integer, humanize returns the number with the proper ordinal appended. e.g. ``` {{humanize "my-first-post"}} → "My first post" {{humanize "myCamelPost"}} → "My camel post" {{humanize "52"}} → "52nd" {{humanize 103}} → "103rd" ``` ### lower Converts all characters in string to lowercase. e.g. `{{lower "BatMan"}}` → "batman" ### markdownify Runs the string through the Markdown processor. The result will be declared as "safe" so Go templates will not filter it. e.g. `{{ .Title | markdownify }}` ### plainify Strips any HTML and returns the plain text version. e.g. `{{ "BatMan" | plainify }}` → "BatMan" ### pluralize Pluralize the given word with a set of common English pluralization rules. e.g. `{{ "cat" | pluralize }}` → "cats" ### findRE Returns a list of strings that match the regular expression. By default all matches will be included. The number of matches can be limitted with an optional third parameter. The example below returns a list of all second level headers (`

`) in the content: {{ findRE "(.|\n)*?

" .Content }} We can limit the number of matches in that list with a third parameter. Let's say we want to have at most one match (or none if no substring matched): {{ findRE "(.|\n)*?" .Content 1 }} `findRE` allows us to build an automatically generated table of contents that could be used for a simple scrollspy: {{ $headers := findRE "(.|\n)*?" .Content }} {{ if ge (len $headers) 1 }} {{ end }} First, we try to find all second-level headers and generate a list if at least one header was found. `plainify` strips the HTML and `urlize` converts the header into an a valid URL. ### replace Replaces all occurrences of the search string with the replacement string. e.g. `{{ replace "Batman and Robin" "Robin" "Catwoman" }}` → "Batman and Catwoman" ### replaceRE Replaces all occurrences of a regular expression with the replacement pattern. e.g. `{{ replaceRE "^https?://([^/]+).*" "$1" "http://gohugo.io/docs" }}` → "gohugo.io" e.g. `{{ "http://gohugo.io/docs" | replaceRE "^https?://([^/]+).*" "$1" }}` → "gohugo.io" ### safeHTML Declares the provided string as a "safe" HTML document fragment so Go html/template will not filter it. It should not be used for HTML from a third-party, or HTML with unclosed tags or comments. Example: Given a site-wide `config.toml` that contains this line: copyright = "© 2015 Jane Doe. Some rights reserved." `{{ .Site.Copyright | safeHTML }}` would then output: > © 2015 Jane Doe. Some rights reserved. However, without the `safeHTML` function, html/template assumes `.Site.Copyright` to be unsafe, escaping all HTML tags, rendering the whole string as plain-text like this:

© 2015 Jane Doe. <a href="http://creativecommons.org/licenses/by/4.0/">Some rights reserved</a>.

### safeHTMLAttr Declares the provided string as a "safe" HTML attribute from a trusted source, for example, ` dir="ltr"`, so Go html/template will not filter it. Example: Given a site-wide `config.toml` that contains this menu entry: [[menu.main]] name = "IRC: #golang at freenode" url = "irc://irc.freenode.net/#golang" * `` ⇒ `` (Bad!) * `` ⇒ `` (Good!) ### safeCSS Declares the provided string as a known "safe" CSS string so Go html/templates will not filter it. "Safe" means CSS content that matches any of: 1. The CSS3 stylesheet production, such as `p { color: purple }`. 2. The CSS3 rule production, such as `a[href=~"https:"].foo#bar`. 3. CSS3 declaration productions, such as `color: red; margin: 2px`. 4. The CSS3 value production, such as `rgba(0, 0, 255, 127)`. Example: Given `style = "color: red;"` defined in the front matter of your `.md` file: * `

…

` ⇒ `

…

` (Good!) * `

…

` ⇒ `

…

` (Bad!) Note: "ZgotmplZ" is a special value that indicates that unsafe content reached a CSS or URL context. ### safeJS Declares the provided string as a known "safe" Javascript string so Go html/templates will not escape it. "Safe" means the string encapsulates a known safe EcmaScript5 Expression, for example, `(x + y * z())`. Template authors are responsible for ensuring that typed expressions do not break the intended precedence and that there is no statement/expression ambiguity as when passing an expression like `{ foo:bar() }\n['foo']()`, which is both a valid Expression and a valid Program with a very different meaning. Example: Given `hash = "619c16f"` defined in the front matter of your `.md` file: * `` ⇒ `` (Good!) * `` ⇒ `` (Bad!) ### singularize Singularize the given word with a set of common English singularization rules. e.g. `{{ "cats" | singularize }}` → "cat" ### slicestr Slicing in `slicestr` is done by specifying a half-open range with two indices, `start` and `end`. For example, 1 and 4 creates a slice including elements 1 through 3. The `end` index can be omitted; it defaults to the string's length. e.g. * `{{slicestr "BatMan" 3}}` → "Man" * `{{slicestr "BatMan" 0 3}}` → "Bat" ### split Split a string into substrings separated by a delimiter. e.g. * `{{split "tag1,tag2,tag3" "," }}` → ["tag1" "tag2" "tag3"] ### string Creates a `string`. e.g. * `{{string "BatMan"}}` → "BatMan" ### substr Extracts parts of a string, beginning at the character at the specified position, and returns the specified number of characters. It normally takes two parameters: `start` and `length`. It can also take one parameter: `start`, i.e. `length` is omitted, in which case the substring starting from start until the end of the string will be returned. To extract characters from the end of the string, use a negative start number. In addition, borrowing from the extended behavior described at http://php.net/substr, if `length` is given and is negative, then that many characters will be omitted from the end of string. e.g. * `{{substr "BatMan" 0 -3}}` → "Bat" * `{{substr "BatMan" 3 3}}` → "Man" ### hasPrefix HasPrefix tests whether a string begins with prefix. * `{{ hasPrefix "Hugo" "Hu" }}` → true ### title Converts all characters in string to titlecase. e.g. `{{title "BatMan"}}` → "Batman" ### trim Returns a slice of the string with all leading and trailing characters contained in cutset removed. e.g. `{{ trim "++Batman--" "+-" }}` → "Batman" ### upper Converts all characters in string to uppercase. e.g. `{{upper "BatMan"}}` → "BATMAN" ### countwords `countwords` tries to convert the passed content to a string and counts each word in it. The template functions works similar to [.WordCount]({{< relref "templates/variables.md#page-variables" >}}). ```html {{ "Hugo is a static site generator." | countwords }} ``` ### countrunes Alternatively to counting all words , `countrunes` determines the number of runes in the content and excludes any whitespace. This can become useful if you have to deal with CJK-like languages. ```html {{ "Hello, 世界" | countrunes }} ``` ### md5 `md5` hashes the given input and returns its MD5 checksum. ```html {{ md5 "Hello world, gophers!" }} ``` This can be useful if you want to use Gravatar for generating a unique avatar: ```html ``` ### sha1 `sha1` hashes the given input and returns its SHA1 checksum. ```html {{ sha1 "Hello world, gophers!" }} ``` ### sha256 `sha256` hashes the given input and returns its SHA256 checksum. ```html {{ sha256 "Hello world, gophers!" }} ``` ## Internationalization ### i18n This translates a piece of content based on your `i18n/en-US.yaml` (and friends) files. You can use the [go-i18n](https://github.com/nicksnyder/go-i18n) tools to manage your translations. The translations can exist in both the theme and at the root of your repository. e.g.: `{{ i18n "translation_id" }}` For more information about string translations, see [Translation of strings]({{< relref "content/multilingual.md#translation-of-strings">}}). ### T `T` is an alias to `i18n`. E.g. `{{ T "translation_id" }}`. ## Times ### time `time` converts a timestamp string into a [`time.Time`](https://godoc.org/time#Time) structure so you can access its fields. E.g. * `{{ time "2016-05-28" }}` → "2016-05-28T00:00:00Z" * `{{ (time "2016-05-28").YearDay }}` → 149 * `{{ mul 1000 (time "2016-05-28T10:30:00.00+10:00").Unix }}` → 1464395400000 (Unix time in milliseconds) ## URLs ### absLangURL, relLangURL These are similar to the `absURL` and `relURL` relatives below, but will add the correct language prefix when the site is configured with more than one language. So for a site `baseURL` set to `http://mysite.com/hugo/` and the current language is `en`: * `{{ "blog/" | absLangURL }}` → "http://mysite.com/hugo/en/blog/" * `{{ "blog/" | relLangURL }}` → "/hugo/en/blog/" ### absURL, relURL Both `absURL` and `relURL` considers the configured value of `baseURL`, so given a `baseURL` set to `http://mysite.com/hugo/`: * `{{ "mystyle.css" | absURL }}` → "http://mysite.com/hugo/mystyle.css" * `{{ "mystyle.css" | relURL }}` → "/hugo/mystyle.css" * `{{ "http://gohugo.io/" | relURL }}` → "http://gohugo.io/" * `{{ "http://gohugo.io/" | absURL }}` → "http://gohugo.io/" The last two examples may look funky, but is useful if you, say, have a list of images, some of them hosted externally, some locally: ``` ``` The above also exploits the fact that the Go template parser JSON-encodes objects inside `script` tags. **Note:** These functions are smart about missing slashes, but will not add one to the end if not present. ### ref, relref Looks up a content page by relative path or logical name to return the permalink (`ref`) or relative permalink (`relref`). Requires a `Page` object (usually satisfied with `.`). Used in the [`ref` and `relref` shortcodes]({{% ref "extras/crossreferences.md" %}}). e.g. {{ ref . "about.md" }} ### safeURL Declares the provided string as a "safe" URL or URL substring (see [RFC 3986][]). A URL like `javascript:checkThatFormNotEditedBeforeLeavingPage()` from a trusted source should go in the page, but by default dynamic `javascript:` URLs are filtered out since they are a frequently exploited injection vector. [RFC 3986]: http://tools.ietf.org/html/rfc3986 Without `safeURL`, only the URI schemes `http:`, `https:` and `mailto:` are considered safe by Go. If any other URI schemes, e.g. `irc:` and `javascript:`, are detected, the whole URL would be replaced with `#ZgotmplZ`. This is to "defang" any potential attack in the URL, rendering it useless. Example: Given a site-wide `config.toml` that contains this menu entry: [[menu.main]] name = "IRC: #golang at freenode" url = "irc://irc.freenode.net/#golang" The following template: would produce `
  • IRC: #golang at freenode
    • ` for the `irc://…` URL. To fix this, add ` | safeURL` after `.URL` on the 3rd line, like this:
  • {{ .Name }}
    • With this change, we finally get `
  • IRC: #golang at freenode
    • ` as intended. ### urlize Takes a string and sanitizes it for usage in URLs, converts spaces to "-". e.g. `{{ . }}` ### querify Takes a set of key-value pairs and returns a [query string](https://en.wikipedia.org/wiki/Query_string) that can be appended to a URL. E.g. Search will be rendered as Search ## Content Views ### Render Takes a view to render the content with. The view is an alternate layout, and should be a file name that points to a template in one of the locations specified in the documentation for [Content Views](/templates/views). This function is only available on a piece of content, and in list context. This example could render a piece of content using the content view located at `/layouts/_default/summary.html`: {{ range .Data.Pages }} {{ .Render "summary"}} {{ end }} ## Advanced ### apply Given a map, array, or slice, returns a new slice with a function applied over it. Expects at least three parameters, depending on the function being applied. The first parameter is the sequence to operate on; the second is the name of the function as a string, which must be in the Hugo function map (generally, it is these functions documented here). After that, the parameters to the applied function are provided, with the string `"."` standing in for each element of the sequence the function is to be applied against. An example is in order: +++ names: [ "Derek Perkins", "Joe Bergevin", "Tanner Linsley" ] +++ {{ apply .Params.names "urlize" "." }} → [ "derek-perkins", "joe-bergevin", "tanner-linsley" ] This is roughly equivalent to: {{ range .Params.names }}{{ . | urlize }}{{ end }} However, it isn’t possible to provide the output of a range to the `delimit` function, so you need to `apply` it. A more complete example should explain this. Let's say you have two partials for displaying tag links in a post, "post/tag/list.html" and "post/tag/link.html", as shown below. {{ with .Params.tags }}
    Tags: {{ $len := len . }} {{ if eq $len 1 }} {{ partial "post/tag/link" (index . 0) }} {{ else }} {{ $last := sub $len 1 }} {{ range first $last . }} {{ partial "post/tag/link" . }}, {{ end }} {{ partial "post/tag/link" (index . $last) }} {{ end }}
    {{ end }} {{ . }} This works, but the complexity of "post/tag/list.html" is fairly high; the Hugo template needs to perform special behaviour for the case where there’s only one tag, and it has to treat the last tag as special. Additionally, the tag list will be rendered something like "Tags: tag1 , tag2 , tag3" because of the way that the HTML is generated and it is interpreted by a browser. This is Hugo. We have a better way. If this were your "post/tag/list.html" instead, all of those problems are fixed automatically (this first version separates all of the operations for ease of reading; the combined version will be shown after the explanation). {{ with .Params.tags }}
    Tags: {{ $sort := sort . }} {{ $links := apply $sort "partial" "post/tag/link" "." }} {{ $clean := apply $links "chomp" "." }} {{ delimit $clean ", " }}
    {{ end }} In this version, we are now sorting the tags, converting them to links with "post/tag/link.html", cleaning off stray newlines, and joining them together in a delimited list for presentation. That can also be written as: {{ with .Params.tags }}
    Tags: {{ delimit (apply (apply (sort .) "partial" "post/tag/link" ".") "chomp" ".") ", " }}
    {{ end }} `apply` does not work when receiving the sequence as an argument through a pipeline. *** ### base64Encode and base64Decode `base64Encode` and `base64Decode` let you easily decode content with a base64 encoding and vice versa through pipes. Let's take a look at an example: {{ "Hello world" | base64Encode }} {{ "SGVsbG8gd29ybGQ=" | base64Decode }} You can also pass other datatypes as argument to the template function which tries to convert them. Now we use an integer instead of a string: {{ 42 | base64Encode | base64Decode }} **Tip:** Using base64 to decode and encode becomes really powerful if we have to handle responses of APIs. {{ $resp := getJSON "https://api.github.com/repos/spf13/hugo/readme" }} {{ $resp.content | base64Decode | markdownify }} The response of the GitHub API contains the base64-encoded version of the [README.md](https://github.com/spf13/hugo/blob/master/README.md) in the Hugo repository. Now we can decode it and parse the Markdown. The final output will look similar to the rendered version on GitHub. *** ### partialCached See [Template Partials]({{< relref "templates/partials.md#cached-partials" >}}) for an explanation of the `partialCached` template function. ## .Site.GetPage Every `Page` has a `Kind` attribute that shows what kind of page it is. While this attribute can be used to list pages of a certain `kind` using `where`, often it can be useful to fetch a single page by its path. `GetPage` looks up an index page of a given `Kind` and `path`. This method may support regular pages in the future, but currently it is a convenient way of getting the index pages, such as the home page or a section, from a template: {{ with .Site.GetPage "section" "blog" }}{{ .Title }}{{ end }} This method wil return `nil` when no page could be found, so the above will not print anything if the blog section isn't found. The valid page kinds are: *home, section, taxonomy and taxonomyTerm.* hugo-0.18.1/docs/content/templates/go-templates.md000066400000000000000000000322221303124201100220520ustar00rootroot00000000000000--- aliases: - /layout/go-templates/ - /layouts/go-templates/ lastmod: 2015-11-30 date: 2013-07-01 menu: main: parent: layout next: /templates/ace prev: /templates/overview title: Go Template Primer weight: 15 toc: true --- Hugo uses the excellent [Go][] [html/template][gohtmltemplate] library for its template engine. It is an extremely lightweight engine that provides a very small amount of logic. In our experience it is just the right amount of logic to be able to create a good static website. If you have used other template systems from different languages or frameworks, you will find a lot of similarities in Go templates. This document is a brief primer on using Go templates. The [Go docs][gohtmltemplate] go into more depth and cover features that aren't mentioned here. ## Introduction to Go Templates Go templates provide an extremely simple template language. It adheres to the belief that only the most basic of logic belongs in the template or view layer. One consequence of this simplicity is that Go templates parse very quickly. A unique characteristic of Go templates is they are content aware. Variables and content will be sanitized depending on the context of where they are used. More details can be found in the [Go docs][gohtmltemplate]. ## Basic Syntax Go lang templates are HTML files with the addition of variables and functions. **Go variables and functions are accessible within {{ }}** Accessing a predefined variable "foo": {{ foo }} **Parameters are separated using spaces** Calling the `add` function with input of 1, 2: {{ add 1 2 }} **Methods and fields are accessed via dot notation** Accessing the Page Parameter "bar" {{ .Params.bar }} **Parentheses can be used to group items together** {{ if or (isset .Params "alt") (isset .Params "caption") }} Caption {{ end }} ## Variables Each Go template has a struct (object) made available to it. In Hugo, each template is passed page struct. More details are available on the [variables](/layout/variables/) page. A variable is accessed by referencing the variable name. {{ .Title }} Variables can also be defined and referenced. {{ $address := "123 Main St."}} {{ $address }} ## Functions Go template ships with a few functions which provide basic functionality. The Go template system also provides a mechanism for applications to extend the available functions with their own. [Hugo template functions](/layout/functions/) provide some additional functionality we believe are useful for building websites. Functions are called by using their name followed by the required parameters separated by spaces. Template functions cannot be added without recompiling Hugo. **Example 1: Adding numbers** {{ add 1 2 }} **Example 2: Comparing numbers** {{ lt 1 2 }} (There are more boolean operators, detailed in the [template documentation](http://golang.org/pkg/text/template/#hdr-Functions).) ## Includes When including another template, you will pass to it the data it will be able to access. To pass along the current context, please remember to include a trailing dot. The templates location will always be starting at the /layout/ directory within Hugo. **Example:** {{ template "partials/header.html" . }} And, starting with Hugo v0.12, you may also use the `partial` call for [partial templates](/templates/partials/): {{ partial "header.html" . }} ## Logic Go templates provide the most basic iteration and conditional logic. ### Iteration Just like in Go, the Go templates make heavy use of `range` to iterate over a map, array or slice. The following are different examples of how to use range. **Example 1: Using Context** {{ range array }} {{ . }} {{ end }} **Example 2: Declaring value variable name** {{range $element := array}} {{ $element }} {{ end }} **Example 2: Declaring key and value variable name** {{range $index, $element := array}} {{ $index }} {{ $element }} {{ end }} ### Conditionals `if`, `else`, `with`, `or` & `and` provide the framework for handling conditional logic in Go Templates. Like `range`, each statement is closed with `end`. Go Templates treat the following values as false: * false * 0 * any array, slice, map, or string of length zero **Example 1: `if`** {{ if isset .Params "title" }}

    {{ index .Params "title" }}

    {{ end }} **Example 2: `if` … `else`** {{ if isset .Params "alt" }} {{ index .Params "alt" }} {{else}} {{ index .Params "caption" }} {{ end }} **Example 3: `and` & `or`** {{ if and (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr")}} **Example 4: `with`** An alternative way of writing "`if`" and then referencing the same value is to use "`with`" instead. `with` rebinds the context `.` within its scope, and skips the block if the variable is absent. The first example above could be simplified as: {{ with .Params.title }}

    {{ . }}

    {{ end }} **Example 5: `if` … `else if`** {{ if isset .Params "alt" }} {{ index .Params "alt" }} {{ else if isset .Params "caption" }} {{ index .Params "caption" }} {{ end }} ## Pipes One of the most powerful components of Go templates is the ability to stack actions one after another. This is done by using pipes. Borrowed from Unix pipes, the concept is simple, each pipeline's output becomes the input of the following pipe. Because of the very simple syntax of Go templates, the pipe is essential to being able to chain together function calls. One limitation of the pipes is that they only can work with a single value and that value becomes the last parameter of the next pipeline. A few simple examples should help convey how to use the pipe. **Example 1:** {{ shuffle (seq 1 5) }} is the same as {{ (seq 1 5) | shuffle }} **Example 2:** {{ index .Params "disqus_url" | html }} Access the page parameter called "disqus_url" and escape the HTML. The `index` function is a [Go][] built-in, and you can read about it [here][gostdlibpkgtexttemplate]. `index`: > ...returns the result of indexing its first argument by the following arguments. Thus "index x 1 2 3" is, in Go syntax, `x[1][2][3]`. Each indexed item must be a map, slice, or array. **Example 3:** {{ if or (or (isset .Params "title") (isset .Params "caption")) (isset .Params "attr") }} Stuff Here {{ end }} Could be rewritten as {{ if isset .Params "caption" | or isset .Params "title" | or isset .Params "attr" }} Stuff Here {{ end }} ### Internet Explorer conditional comments using Pipes By default, Go Templates remove HTML comments from output. This has the unfortunate side effect of removing Internet Explorer conditional comments. As a workaround, use something like this: {{ "" | safeHTML }} Alternatively, use the backtick (`` ` ``) to quote the IE conditional comments, avoiding the tedious task of escaping every double quotes (`"`) inside, as demonstrated in the [examples](http://golang.org/pkg/text/template/#hdr-Examples) in the Go text/template documentation, e.g.: ``` {{ `` | safeHTML }} ``` ## Context (a.k.a. the dot) The most easily overlooked concept to understand about Go templates is that `{{ . }}` always refers to the current context. In the top level of your template, this will be the data set made available to it. Inside of a iteration, however, it will have the value of the current item. When inside of a loop, the context has changed: `{{ . }}` will no longer refer to the data available to the entire page. If you need to access this from within the loop, you will likely want to do one of the following: 1. Set it to a variable instead of depending on the context. For example: {{ $title := .Site.Title }} {{ range .Params.tags }}
  • {{ . }} - {{ $title }}
    • {{ end }} Notice how once we have entered the loop the value of `{{ . }}` has changed. We have defined a variable outside of the loop so we have access to it from within the loop. 2. Use `$.` to access the global context from anywhere. Here is an equivalent example: {{ range .Params.tags }}
  • {{ . }} - {{ $.Site.Title }}
    • {{ end }} This is because `$`, a special variable, is set to the starting value of `.` the dot by default, a [documented feature](http://golang.org/pkg/text/template/#hdr-Variables) of Go text/template. Very handy, eh? > However, this little magic would cease to work if someone were to > mischievously redefine `$`, e.g. `{{ $ := .Site }}`. > *(No, don't do it!)* > You may, of course, recover from this mischief by using `{{ $ := . }}` > in a global context to reset `$` to its default value. ## Whitespace Go 1.6 includes the ability to trim the whitespace from either side of a Go tag by including a hyphen (`-`) and space immediately beside the corresponding `{{` or `}}` delimiter. For instance, the following Go template: ```html
    {{ .Title }}
    ``` will include the newlines and horizontal tab in its HTML output: ```html
    Hello, World!
    ``` whereas using ```html
    {{- .Title -}}
    ``` in that case will output simply `
    Hello, World!
    `. Go considers the following characters as whitespace: space, horizontal tab, carriage return and newline. # Hugo Parameters Hugo provides the option of passing values to the template language through the site configuration (for sitewide values), or through the meta data of each specific piece of content. You can define any values of any type (supported by your front matter/config format) and use them however you want to inside of your templates. ## Using Content (page) Parameters In each piece of content, you can provide variables to be used by the templates. This happens in the [front matter](/content/front-matter/). An example of this is used in this documentation site. Most of the pages benefit from having the table of contents provided. Sometimes the TOC just doesn't make a lot of sense. We've defined a variable in our front matter of some pages to turn off the TOC from being displayed. Here is the example front matter: ``` --- title: "Permalinks" lastmod: 2015-11-30 date: "2013-11-18" aliases: - "/doc/permalinks/" groups: ["extras"] groups_weight: 30 notoc: true --- ``` Here is the corresponding code inside of the template: {{ if not .Params.notoc }}
    {{ .TableOfContents }}
    {{ end }} ## Using Site (config) Parameters In your top-level configuration file (e.g., `config.yaml`) you can define site parameters, which are values which will be available to you in partials. For instance, you might declare: ```yaml params: CopyrightHTML: "Copyright © 2013 John Doe. All Rights Reserved." TwitterUser: "spf13" SidebarRecentLimit: 5 ``` Within a footer layout, you might then declare a `