├── .gitignore ├── .gitmodules ├── README.md ├── archetypes ├── default.md ├── functions.md ├── showcase.md └── tutorials.md ├── config.toml ├── content ├── _index.md ├── about │ ├── _index.md │ ├── benefits.md │ ├── features.md │ ├── license.md │ ├── roadmap.md │ └── what-is-hugo.md ├── commands │ ├── _index.md │ ├── hugo.md │ ├── hugo_benchmark.md │ ├── hugo_check.md │ ├── hugo_check_ulimit.md │ ├── hugo_config.md │ ├── hugo_convert.md │ ├── hugo_convert_toJSON.md │ ├── hugo_convert_toTOML.md │ ├── hugo_convert_toYAML.md │ ├── hugo_env.md │ ├── hugo_gen.md │ ├── hugo_gen_autocomplete.md │ ├── hugo_gen_doc.md │ ├── hugo_gen_man.md │ ├── hugo_import.md │ ├── hugo_import_jekyll.md │ ├── hugo_list.md │ ├── hugo_list_drafts.md │ ├── hugo_list_expired.md │ ├── hugo_list_future.md │ ├── hugo_new.md │ ├── hugo_new_site.md │ ├── hugo_new_theme.md │ ├── hugo_server.md │ ├── hugo_undraft.md │ └── hugo_version.md ├── content-management │ ├── _index.md │ ├── archetypes.md │ ├── authors.md │ ├── comments.md │ ├── cross-references.md │ ├── formats.md │ ├── front-matter.md │ ├── menus.md │ ├── multilingual.md │ ├── organization.md │ ├── sections.md │ ├── shortcodes.md │ ├── summaries.md │ ├── taxonomies.md │ ├── toc.md │ ├── types.md │ └── urls.md ├── contribute │ ├── _index.md │ ├── development.md │ ├── documentation.md │ └── themes.md ├── documentation.md ├── functions │ ├── GetPage.md │ ├── NumFmt.md │ ├── _index.md │ ├── abslangurl.md │ ├── absurl.md │ ├── adddate.md │ ├── after.md │ ├── apply.md │ ├── base64.md │ ├── chomp.md │ ├── countrunes.md │ ├── countwords.md │ ├── dateformat.md │ ├── default.md │ ├── delimit.md │ ├── dict.md │ ├── echoparam.md │ ├── emojify.md │ ├── eq.md │ ├── findRe.md │ ├── first.md │ ├── format.md │ ├── get.md │ ├── getenv.md │ ├── hasPrefix.md │ ├── haschildren.md │ ├── hasmenucurrent.md │ ├── highlight.md │ ├── htmlEscape.md │ ├── htmlUnescape.md │ ├── humanize.md │ ├── i18n.md │ ├── imageConfig.md │ ├── in.md │ ├── index-function.md │ ├── int.md │ ├── intersect.md │ ├── ismenucurrent.md │ ├── isset.md │ ├── jsonify.md │ ├── last.md │ ├── len.md │ ├── lower.md │ ├── markdownify.md │ ├── math.md │ ├── md5.md │ ├── now.md │ ├── param.md │ ├── partialCached.md │ ├── plainify.md │ ├── pluralize.md │ ├── printf.md │ ├── querify.md │ ├── range.md │ ├── readdir.md │ ├── readfile.md │ ├── ref.md │ ├── relLangURL.md │ ├── relref.md │ ├── relurl.md │ ├── render.md │ ├── replace.md │ ├── replacere.md │ ├── safeCSS.md │ ├── safeHTML.md │ ├── safeHTMLAttr.md │ ├── safeJS.md │ ├── safeURL.md │ ├── scratch.md │ ├── seq.md │ ├── sha.md │ ├── shuffle.md │ ├── singularize.md │ ├── slice.md │ ├── slicestr.md │ ├── sort.md │ ├── split.md │ ├── string.md │ ├── substr.md │ ├── time.md │ ├── title.md │ ├── trim.md │ ├── truncate.md │ ├── union.md │ ├── uniq.md │ ├── unix.md │ ├── upper.md │ ├── urlize.md │ ├── where.md │ └── with.md ├── getting-started │ ├── _index.md │ ├── configuration.md │ ├── directory-structure.md │ ├── installing.md │ ├── quick-start.md │ └── usage.md ├── hosting-and-deployment │ ├── _index.md │ ├── deployment-with-rsync.md │ ├── deployment-with-wercker.md │ ├── hosting-on-bitbucket.md │ ├── hosting-on-firebase.md │ ├── hosting-on-github.md │ ├── hosting-on-gitlab.md │ └── hosting-on-netlify.md ├── mailing-list.md ├── news │ ├── 0-16.md │ ├── 0-17.md │ ├── 0-18.md │ ├── 0-19.md │ ├── _index.md │ ├── press-and-articles.md │ └── release-notes.md ├── readfiles │ ├── README.md │ ├── bfconfig.md │ ├── dateformatting.md │ ├── menuvars.md │ └── testing.txt ├── templates │ ├── 404.md │ ├── _index.md │ ├── alternatives.md │ ├── base.md │ ├── data-templates.md │ ├── files.md │ ├── homepage.md │ ├── internal.md │ ├── introduction.md │ ├── lists.md │ ├── lookup-order.md │ ├── menu-templates.md │ ├── ordering-and-grouping.md │ ├── output-formats.md │ ├── pagination.md │ ├── partials.md │ ├── robots.md │ ├── rss.md │ ├── section-templates.md │ ├── shortcode-templates.md │ ├── single-page-templates.md │ ├── sitemap-template.md │ ├── taxonomy-templates.md │ ├── template-debugging.md │ └── views.md ├── themes │ ├── _index.md │ ├── creating.md │ ├── customizing.md │ └── installing-and-using-themes.md ├── tools │ ├── _index.md │ ├── editors.md │ ├── frontends.md │ ├── migrations.md │ ├── other.md │ ├── search.md │ ├── starter-kits.md │ └── syntax-highlighting.md ├── tree.txt ├── troubleshooting │ ├── _index.md │ ├── accented-characters-in-urls.md │ ├── build-performance.md │ └── eof-error.md └── variables │ ├── _index.md │ ├── files.md │ ├── git.md │ ├── hugo.md │ ├── menus.md │ ├── page.md │ ├── shortcodes.md │ ├── site.md │ ├── sitemap.md │ └── taxonomy.md ├── data ├── docs.json └── homepagetweets.toml ├── layouts ├── _default │ ├── baseof.html │ ├── list.html │ ├── single.html │ ├── taxonomy.html │ └── terms.html ├── index.html ├── partials │ └── temp-closing.html └── shortcodes │ ├── articlelist.html │ ├── code.html │ ├── datatable.html │ ├── directoryindex.html │ ├── docfile.html │ ├── exfile.html │ ├── exfm.html │ ├── gh.html │ ├── ghrepo.html │ ├── needsexamples.html │ ├── nohighlight.html │ ├── note.html │ ├── output.html │ ├── readfile.html │ ├── tip.html │ ├── warning.html │ └── yt.html └── static ├── _headers ├── contribute └── development │ ├── accept-cla.png │ ├── ci-errors.png │ ├── copy-remote-url.png │ ├── forking-a-repository.png │ └── open-pull-request.png ├── hosting-and-deployment ├── deployment-with-wercker │ ├── adding-a-github-pages-step.png │ ├── adding-the-project-to-github.png │ ├── and-we-ve-got-an-app.png │ ├── configure-the-deploy-step.png │ ├── creating-a-basic-hugo-site.png │ ├── public-or-not.png │ ├── using-hugo-build.png │ ├── wercker-access.png │ ├── wercker-account-settings.png │ ├── wercker-add-app.png │ ├── wercker-git-connections.png │ ├── wercker-search.png │ ├── wercker-select-owner.png │ ├── wercker-select-repository.png │ ├── wercker-sign-up-page.png │ ├── wercker-sign-up.png │ └── werckeryml.png ├── hosting-on-bitbucket │ ├── bitbucket-blog-post.png │ └── bitbucket-create-repo.png └── hosting-on-netlify │ ├── netlify-add-new-site.jpg │ ├── netlify-authorize-added-permissions.jpg │ ├── netlify-create-new-site-step-1.jpg │ ├── netlify-create-new-site-step-2.jpg │ ├── netlify-create-new-site-step-3.jpg │ ├── netlify-deploy-published.jpg │ ├── netlify-deploying-site.gif │ ├── netlify-first-authorize.jpg │ ├── netlify-live-site.jpg │ ├── netlify-push-to-deploy.jpg │ ├── netlify-signup.jpg │ └── tibobeijennl.jpg ├── images ├── contribute │ └── development │ │ ├── accept-cla.png │ │ ├── ci-errors.png │ │ ├── copy-remote-url.png │ │ ├── forking-a-repository.png │ │ └── open-pull-request.png ├── hosting-and-deployment │ ├── deployment-with-wercker │ │ ├── adding-a-github-pages-step.png │ │ ├── adding-the-project-to-github.png │ │ ├── and-we-ve-got-an-app.png │ │ ├── configure-the-deploy-step.png │ │ ├── creating-a-basic-hugo-site.png │ │ ├── public-or-not.png │ │ ├── using-hugo-build.png │ │ ├── wercker-access.png │ │ ├── wercker-account-settings.png │ │ ├── wercker-add-app.png │ │ ├── wercker-git-connections.png │ │ ├── wercker-search.png │ │ ├── wercker-select-owner.png │ │ ├── wercker-select-repository.png │ │ ├── wercker-sign-up-page.png │ │ ├── wercker-sign-up.png │ │ └── werckeryml.png │ ├── hosting-on-bitbucket │ │ ├── bitbucket-blog-post.png │ │ └── bitbucket-create-repo.png │ └── hosting-on-netlify │ │ ├── netlify-add-new-site.jpg │ │ ├── netlify-authorize-added-permissions.jpg │ │ ├── netlify-create-new-site-step-1.jpg │ │ ├── netlify-create-new-site-step-2.jpg │ │ ├── netlify-create-new-site-step-3.jpg │ │ ├── netlify-deploy-published.jpg │ │ ├── netlify-deploying-site.gif │ │ ├── netlify-first-authorize.jpg │ │ ├── netlify-live-site.jpg │ │ ├── netlify-push-to-deploy.jpg │ │ ├── netlify-signup.jpg │ │ └── tibobeijennl.jpg ├── icon-custom-outputs.svg ├── quickstart │ ├── bookshelf-bleak-theme.png │ ├── bookshelf-disqus.png │ ├── bookshelf-new-default-image.png │ ├── bookshelf-only-picture.png │ ├── bookshelf-robust-theme.png │ ├── bookshelf-updated-config.png │ ├── bookshelf.png │ ├── default.jpg │ └── gh-pages-ui.png └── site-hierarchy.svg └── quickstart ├── bookshelf-bleak-theme.png ├── bookshelf-disqus.png ├── bookshelf-new-default-image.png ├── bookshelf-only-picture.png ├── bookshelf-robust-theme.png ├── bookshelf-updated-config.png ├── bookshelf.png ├── default.jpg └── gh-pages-ui.png /.gitignore: -------------------------------------------------------------------------------- 1 | pipeline/node_modules 2 | ryans-notes.md 3 | themes/hugo-docs-concept/pipeline/node_modules 4 | public 5 | .DS_Store 6 | 7 | .netlify 8 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "themes/gohugoioTheme"] 2 | path = themes/gohugoioTheme 3 | url = https://github.com/gohugoio/gohugoioTheme.git 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Hugo Docs Temporary POC 2 | 3 | ## **This repository is now closed** 4 | 5 | First of all, thank you to everyone who provided feedback on the new documentation. It is *greatly* appreciated. 6 | 7 | 1. Moving forward, if you have any requests or suggestions for documentation improvement, please file an issue in the new Hugo docs repo: 8 | 2. If you have an open issue for this repository, the Hugo team will take care of moving relevant issues over to the official repo within the Hugo GH Organization. 9 | -------------------------------------------------------------------------------- /archetypes/default.md: -------------------------------------------------------------------------------- 1 | --- 2 | linktitle: "" 3 | description: "" 4 | godocref: "" 5 | publishdate: "" 6 | lastmod: "" 7 | categories: [] 8 | tags: [] 9 | weight: 00 10 | slug: "" 11 | aliases: [] 12 | toc: false 13 | --- 14 | -------------------------------------------------------------------------------- /archetypes/functions.md: -------------------------------------------------------------------------------- 1 | --- 2 | linktitle: "" 3 | description: "" 4 | godocref: "" 5 | publishdate: "" 6 | lastmod: "" 7 | categories: [functions] 8 | tags: [] 9 | ns: "" 10 | signature: [] 11 | workson: [] 12 | hugoversion: "" 13 | aliases: [] 14 | relatedfuncs: [] 15 | toc: false 16 | deprecated: false 17 | needsexamples: true 18 | --- -------------------------------------------------------------------------------- /archetypes/showcase.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: "" 3 | lastmod: "" 4 | license: "" 5 | licenseLink: "" 6 | sitelink: "" 7 | sourcelink: "" 8 | categories: [showcase] 9 | tags: [] 10 | image: "" 11 | toc: false 12 | notesforauthors: "Go to gohugo.io/contribute/documentation for more info" 13 | --- -------------------------------------------------------------------------------- /archetypes/tutorials.md: -------------------------------------------------------------------------------- 1 | --- 2 | linktitle: "" 3 | description: "" 4 | godocref: "" 5 | publishdate: "" 6 | lastmod: "" 7 | categories: [tutorials] 8 | tags: [] 9 | author: "" 10 | authorurl: "" 11 | originalurl: "" 12 | draft: false 13 | aliases: [] 14 | notesforauthors: "Go to gohugo.io/contribute/documentation for more info." 15 | --- 16 | 17 | -------------------------------------------------------------------------------- /content/about/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: About Hugo 3 | linktitle: Overview 4 | description: Hugo's features, roadmap, license, and motivation. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [] 9 | tags: [] 10 | menu: 11 | docs: 12 | parent: "about" 13 | weight: 1 14 | weight: 1 15 | draft: false 16 | aliases: [/about-hugo/,/docs/] 17 | toc: false 18 | --- 19 | 20 | Hugo is not your average static site generator. 21 | -------------------------------------------------------------------------------- /content/about/roadmap.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Roadmap 3 | linktitle: Roadmap 4 | description: Take a look at what's in the pipeline for future versions of the Hugo project. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [about hugo] 9 | tags: [about,contribute,roadmap] 10 | menu: 11 | docs: 12 | parent: "about" 13 | weight: 50 14 | weight: 50 15 | sections_weight: 50 16 | draft: false 17 | aliases: [/meta/roadmap] 18 | toc: false 19 | --- 20 | 21 | To track Hugo's progress, see our [GitHub Milestones][milestones]. 22 | 23 | In no particular order, here are some other features currently being worked on: 24 | 25 | * Even easier deployment to S3, SSH, GitHub, rsync. Give the [hosting and deployment][] section a shot. 26 | * Import from other website systems. There are already [existing migration tools][migrate], but they don’t cover all major platforms. 27 | * An interactive web-based editor (See the [related forum thread][]) 28 | * Additional [themes][], which are always ongoing and [contributions are welcome][themescontrib]! 29 | * Dynamic image resizing via shortcodes ({{< gh 1014 >}}) 30 | * Native support for additional content formats (AsciiDoc {{< gh 1435>}}, reST {{< gh 1436 >}}) 31 | * And, last but not least, [***your*** best ideas!][] 32 | 33 | ## Contributions Welcome 34 | 35 | Feel free to [contribute to Hugo's development][devcontribute], [improve Hugo's documentation][doccontribute], or [open a new issue][newissue] if you have an idea for a new feature. 36 | 37 | [#98]: https://github.com/spf13/hugo/issues/98 38 | [#1014]: https://github.com/spf13/hugo/issues/1014 39 | [#1435]: https://github.com/spf13/hugo/issues/1435 40 | [#1436]: https://github.com/spf13/hugo/issues/1436 41 | [devcontribute]: /contribute/development/ 42 | [doccontribute]: /contribute/documentation/ 43 | [hosting and deployment]: /hosting-and-deployment/ 44 | [migrate]: /tools/migrations/ 45 | [milestones]: https://github.com/spf13/hugo/milestone/14 46 | [newissue]: https://github.com/spf13/hugo/issues/ 47 | [related forum thread]: https://disourse.gohugo.io/t/web-based-editor/155 48 | [themes]: /themes/ 49 | [themescontrib]: /contribute/themes/ 50 | [tutorials]: /tutorials 51 | [***your*** best ideas!]: /contribute/ 52 | -------------------------------------------------------------------------------- /content/commands/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Command Line Reference 3 | linktitle: CLI Overview 4 | description: Comprehensive list of Hugo templating functions, including basic and advanced usage examples. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [commands] 9 | tags: [cli,command line] 10 | menu: 11 | docs: 12 | parent: "commands" 13 | weight: 1 14 | weight: 01 #rem 15 | draft: false 16 | aliases: [/cli/] 17 | --- 18 | 19 | The following list contains auto-generated and up-to-date (thanks to [Cobra][]) documentation for all the CLI commands in Hugo. 20 | 21 | 22 | [Cobra]: https://github.com/spf13/cobra 23 | -------------------------------------------------------------------------------- /content/commands/hugo_check.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo check" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_check 8 | url: /commands/hugo_check/ 9 | --- 10 | ## hugo check 11 | 12 | Contains some verification checks 13 | 14 | ### Synopsis 15 | 16 | 17 | Contains some verification checks 18 | 19 | ### Options inherited from parent commands 20 | 21 | ``` 22 | --config string config file (default is path/config.yaml|json|toml) 23 | --log Enable Logging 24 | --logFile string Log File path (if set, logging enabled automatically) 25 | --quiet build in quiet mode 26 | -v, --verbose verbose output 27 | --verboseLog verbose logging 28 | ``` 29 | 30 | ### SEE ALSO 31 | * [hugo](/commands/hugo/) - hugo builds your site 32 | * [hugo check ulimit](/commands/hugo_check_ulimit/) - Check system ulimit settings 33 | 34 | ###### Auto generated by spf13/cobra on 25-Feb-2017 35 | -------------------------------------------------------------------------------- /content/commands/hugo_check_ulimit.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo check ulimit" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_check_ulimit 8 | url: /commands/hugo_check_ulimit/ 9 | --- 10 | ## hugo check ulimit 11 | 12 | Check system ulimit settings 13 | 14 | ### Synopsis 15 | 16 | 17 | Hugo will inspect the current ulimit settings on the system. 18 | This is primarily to ensure that Hugo can watch enough files on some OSs 19 | 20 | ``` 21 | hugo check ulimit 22 | ``` 23 | 24 | ### Options inherited from parent commands 25 | 26 | ``` 27 | --config string config file (default is path/config.yaml|json|toml) 28 | --log Enable Logging 29 | --logFile string Log File path (if set, logging enabled automatically) 30 | --quiet build in quiet mode 31 | -v, --verbose verbose output 32 | --verboseLog verbose logging 33 | ``` 34 | 35 | ### SEE ALSO 36 | * [hugo check](/commands/hugo_check/) - Contains some verification checks 37 | 38 | ###### Auto generated by spf13/cobra on 25-Feb-2017 39 | -------------------------------------------------------------------------------- /content/commands/hugo_config.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo config" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_config 8 | url: /commands/hugo_config/ 9 | --- 10 | ## hugo config 11 | 12 | Print the site configuration 13 | 14 | ### Synopsis 15 | 16 | 17 | Print the site configuration, both default and custom settings. 18 | 19 | ``` 20 | hugo config 21 | ``` 22 | 23 | ### Options inherited from parent commands 24 | 25 | ``` 26 | --config string config file (default is path/config.yaml|json|toml) 27 | --log Enable Logging 28 | --logFile string Log File path (if set, logging enabled automatically) 29 | --quiet build in quiet mode 30 | -v, --verbose verbose output 31 | --verboseLog verbose logging 32 | ``` 33 | 34 | ### SEE ALSO 35 | * [hugo](/commands/hugo/) - hugo builds your site 36 | 37 | ###### Auto generated by spf13/cobra on 25-Feb-2017 38 | -------------------------------------------------------------------------------- /content/commands/hugo_convert.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo convert" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_convert 8 | url: /commands/hugo_convert/ 9 | --- 10 | ## hugo convert 11 | 12 | Convert your content to different formats 13 | 14 | ### Synopsis 15 | 16 | 17 | Convert your content (e.g. front matter) to different formats. 18 | 19 | See convert's subcommands toJSON, toTOML and toYAML for more information. 20 | 21 | ### Options 22 | 23 | ``` 24 | -o, --output string filesystem path to write files to 25 | -s, --source string filesystem path to read files relative from 26 | --unsafe enable less safe operations, please backup first 27 | ``` 28 | 29 | ### Options inherited from parent commands 30 | 31 | ``` 32 | --config string config file (default is path/config.yaml|json|toml) 33 | --log Enable Logging 34 | --logFile string Log File path (if set, logging enabled automatically) 35 | --quiet build in quiet mode 36 | -v, --verbose verbose output 37 | --verboseLog verbose logging 38 | ``` 39 | 40 | ### SEE ALSO 41 | * [hugo](/commands/hugo/) - hugo builds your site 42 | * [hugo convert toJSON](/commands/hugo_convert_tojson/) - Convert front matter to JSON 43 | * [hugo convert toTOML](/commands/hugo_convert_totoml/) - Convert front matter to TOML 44 | * [hugo convert toYAML](/commands/hugo_convert_toyaml/) - Convert front matter to YAML 45 | 46 | ###### Auto generated by spf13/cobra on 25-Feb-2017 47 | -------------------------------------------------------------------------------- /content/commands/hugo_convert_toJSON.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo convert toJSON" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_convert_toJSON 8 | url: /commands/hugo_convert_tojson/ 9 | --- 10 | ## hugo convert toJSON 11 | 12 | Convert front matter to JSON 13 | 14 | ### Synopsis 15 | 16 | 17 | toJSON converts all front matter in the content directory 18 | to use JSON for the front matter. 19 | 20 | ``` 21 | hugo convert toJSON 22 | ``` 23 | 24 | ### Options inherited from parent commands 25 | 26 | ``` 27 | --config string config file (default is path/config.yaml|json|toml) 28 | --log Enable Logging 29 | --logFile string Log File path (if set, logging enabled automatically) 30 | -o, --output string filesystem path to write files to 31 | --quiet build in quiet mode 32 | -s, --source string filesystem path to read files relative from 33 | --unsafe enable less safe operations, please backup first 34 | -v, --verbose verbose output 35 | --verboseLog verbose logging 36 | ``` 37 | 38 | ### SEE ALSO 39 | * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats 40 | 41 | ###### Auto generated by spf13/cobra on 25-Feb-2017 42 | -------------------------------------------------------------------------------- /content/commands/hugo_convert_toTOML.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo convert toTOML" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_convert_toTOML 8 | url: /commands/hugo_convert_totoml/ 9 | --- 10 | ## hugo convert toTOML 11 | 12 | Convert front matter to TOML 13 | 14 | ### Synopsis 15 | 16 | 17 | toTOML converts all front matter in the content directory 18 | to use TOML for the front matter. 19 | 20 | ``` 21 | hugo convert toTOML 22 | ``` 23 | 24 | ### Options inherited from parent commands 25 | 26 | ``` 27 | --config string config file (default is path/config.yaml|json|toml) 28 | --log Enable Logging 29 | --logFile string Log File path (if set, logging enabled automatically) 30 | -o, --output string filesystem path to write files to 31 | --quiet build in quiet mode 32 | -s, --source string filesystem path to read files relative from 33 | --unsafe enable less safe operations, please backup first 34 | -v, --verbose verbose output 35 | --verboseLog verbose logging 36 | ``` 37 | 38 | ### SEE ALSO 39 | * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats 40 | 41 | ###### Auto generated by spf13/cobra on 25-Feb-2017 42 | -------------------------------------------------------------------------------- /content/commands/hugo_convert_toYAML.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo convert toYAML" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_convert_toYAML 8 | url: /commands/hugo_convert_toyaml/ 9 | --- 10 | ## hugo convert toYAML 11 | 12 | Convert front matter to YAML 13 | 14 | ### Synopsis 15 | 16 | 17 | toYAML converts all front matter in the content directory 18 | to use YAML for the front matter. 19 | 20 | ``` 21 | hugo convert toYAML 22 | ``` 23 | 24 | ### Options inherited from parent commands 25 | 26 | ``` 27 | --config string config file (default is path/config.yaml|json|toml) 28 | --log Enable Logging 29 | --logFile string Log File path (if set, logging enabled automatically) 30 | -o, --output string filesystem path to write files to 31 | --quiet build in quiet mode 32 | -s, --source string filesystem path to read files relative from 33 | --unsafe enable less safe operations, please backup first 34 | -v, --verbose verbose output 35 | --verboseLog verbose logging 36 | ``` 37 | 38 | ### SEE ALSO 39 | * [hugo convert](/commands/hugo_convert/) - Convert your content to different formats 40 | 41 | ###### Auto generated by spf13/cobra on 25-Feb-2017 42 | -------------------------------------------------------------------------------- /content/commands/hugo_env.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo env" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_env 8 | url: /commands/hugo_env/ 9 | --- 10 | ## hugo env 11 | 12 | Print Hugo version and environment info 13 | 14 | ### Synopsis 15 | 16 | 17 | Print Hugo version and environment info. This is useful in Hugo bug reports. 18 | 19 | ``` 20 | hugo env 21 | ``` 22 | 23 | ### Options inherited from parent commands 24 | 25 | ``` 26 | --config string config file (default is path/config.yaml|json|toml) 27 | --log Enable Logging 28 | --logFile string Log File path (if set, logging enabled automatically) 29 | --quiet build in quiet mode 30 | -v, --verbose verbose output 31 | --verboseLog verbose logging 32 | ``` 33 | 34 | ### SEE ALSO 35 | * [hugo](/commands/hugo/) - hugo builds your site 36 | 37 | ###### Auto generated by spf13/cobra on 25-Feb-2017 38 | -------------------------------------------------------------------------------- /content/commands/hugo_gen.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo gen" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_gen 8 | url: /commands/hugo_gen/ 9 | --- 10 | ## hugo gen 11 | 12 | A collection of several useful generators. 13 | 14 | ### Synopsis 15 | 16 | 17 | A collection of several useful generators. 18 | 19 | ### Options inherited from parent commands 20 | 21 | ``` 22 | --config string config file (default is path/config.yaml|json|toml) 23 | --log Enable Logging 24 | --logFile string Log File path (if set, logging enabled automatically) 25 | --quiet build in quiet mode 26 | -v, --verbose verbose output 27 | --verboseLog verbose logging 28 | ``` 29 | 30 | ### SEE ALSO 31 | * [hugo](/commands/hugo/) - hugo builds your site 32 | * [hugo gen autocomplete](/commands/hugo_gen_autocomplete/) - Generate shell autocompletion script for Hugo 33 | * [hugo gen doc](/commands/hugo_gen_doc/) - Generate Markdown documentation for the Hugo CLI. 34 | * [hugo gen man](/commands/hugo_gen_man/) - Generate man pages for the Hugo CLI 35 | 36 | ###### Auto generated by spf13/cobra on 25-Feb-2017 37 | -------------------------------------------------------------------------------- /content/commands/hugo_gen_autocomplete.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo gen autocomplete" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_gen_autocomplete 8 | url: /commands/hugo_gen_autocomplete/ 9 | --- 10 | ## hugo gen autocomplete 11 | 12 | Generate shell autocompletion script for Hugo 13 | 14 | ### Synopsis 15 | 16 | 17 | Generates a shell autocompletion script for Hugo. 18 | 19 | NOTE: The current version supports Bash only. 20 | This should work for *nix systems with Bash installed. 21 | 22 | By default, the file is written directly to /etc/bash_completion.d 23 | for convenience, and the command may need superuser rights, e.g.: 24 | 25 | $ sudo hugo gen autocomplete 26 | 27 | Add `--completionfile=/path/to/file` flag to set alternative 28 | file-path and name. 29 | 30 | Logout and in again to reload the completion scripts, 31 | or just source them in directly: 32 | 33 | $ . /etc/bash_completion 34 | 35 | ``` 36 | hugo gen autocomplete 37 | ``` 38 | 39 | ### Options 40 | 41 | ``` 42 | --completionfile string Autocompletion file (default "/etc/bash_completion.d/hugo.sh") 43 | --type string Autocompletion type (currently only bash supported) (default "bash") 44 | ``` 45 | 46 | ### Options inherited from parent commands 47 | 48 | ``` 49 | --config string config file (default is path/config.yaml|json|toml) 50 | --log Enable Logging 51 | --logFile string Log File path (if set, logging enabled automatically) 52 | --quiet build in quiet mode 53 | -v, --verbose verbose output 54 | --verboseLog verbose logging 55 | ``` 56 | 57 | ### SEE ALSO 58 | * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. 59 | 60 | ###### Auto generated by spf13/cobra on 25-Feb-2017 61 | -------------------------------------------------------------------------------- /content/commands/hugo_gen_doc.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo gen doc" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_gen_doc 8 | url: /commands/hugo_gen_doc/ 9 | --- 10 | ## hugo gen doc 11 | 12 | Generate Markdown documentation for the Hugo CLI. 13 | 14 | ### Synopsis 15 | 16 | 17 | Generate Markdown documentation for the Hugo CLI. 18 | 19 | This command is, mostly, used to create up-to-date documentation 20 | of Hugo's command-line interface for http://gohugo.io/. 21 | 22 | It creates one Markdown file per command with front matter suitable 23 | for rendering in Hugo. 24 | 25 | ``` 26 | hugo gen doc 27 | ``` 28 | 29 | ### Options 30 | 31 | ``` 32 | --dir string the directory to write the doc. (default "/tmp/hugodoc/") 33 | ``` 34 | 35 | ### Options inherited from parent commands 36 | 37 | ``` 38 | --config string config file (default is path/config.yaml|json|toml) 39 | --log Enable Logging 40 | --logFile string Log File path (if set, logging enabled automatically) 41 | --quiet build in quiet mode 42 | -v, --verbose verbose output 43 | --verboseLog verbose logging 44 | ``` 45 | 46 | ### SEE ALSO 47 | * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. 48 | 49 | ###### Auto generated by spf13/cobra on 25-Feb-2017 50 | -------------------------------------------------------------------------------- /content/commands/hugo_gen_man.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo gen man" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_gen_man 8 | url: /commands/hugo_gen_man/ 9 | --- 10 | ## hugo gen man 11 | 12 | Generate man pages for the Hugo CLI 13 | 14 | ### Synopsis 15 | 16 | 17 | This command automatically generates up-to-date man pages of Hugo's 18 | command-line interface. By default, it creates the man page files 19 | in the "man" directory under the current directory. 20 | 21 | ``` 22 | hugo gen man 23 | ``` 24 | 25 | ### Options 26 | 27 | ``` 28 | --dir string the directory to write the man pages. (default "man/") 29 | ``` 30 | 31 | ### Options inherited from parent commands 32 | 33 | ``` 34 | --config string config file (default is path/config.yaml|json|toml) 35 | --log Enable Logging 36 | --logFile string Log File path (if set, logging enabled automatically) 37 | --quiet build in quiet mode 38 | -v, --verbose verbose output 39 | --verboseLog verbose logging 40 | ``` 41 | 42 | ### SEE ALSO 43 | * [hugo gen](/commands/hugo_gen/) - A collection of several useful generators. 44 | 45 | ###### Auto generated by spf13/cobra on 25-Feb-2017 46 | -------------------------------------------------------------------------------- /content/commands/hugo_import.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo import" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_import 8 | url: /commands/hugo_import/ 9 | --- 10 | ## hugo import 11 | 12 | Import your site from others. 13 | 14 | ### Synopsis 15 | 16 | 17 | Import your site from other web site generators like Jekyll. 18 | 19 | Import requires a subcommand, e.g. `hugo import jekyll jekyll_root_path target_path`. 20 | 21 | ### Options inherited from parent commands 22 | 23 | ``` 24 | --config string config file (default is path/config.yaml|json|toml) 25 | --log Enable Logging 26 | --logFile string Log File path (if set, logging enabled automatically) 27 | --quiet build in quiet mode 28 | -v, --verbose verbose output 29 | --verboseLog verbose logging 30 | ``` 31 | 32 | ### SEE ALSO 33 | * [hugo](/commands/hugo/) - hugo builds your site 34 | * [hugo import jekyll](/commands/hugo_import_jekyll/) - hugo import from Jekyll 35 | 36 | ###### Auto generated by spf13/cobra on 25-Feb-2017 37 | -------------------------------------------------------------------------------- /content/commands/hugo_import_jekyll.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo import jekyll" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_import_jekyll 8 | url: /commands/hugo_import_jekyll/ 9 | --- 10 | ## hugo import jekyll 11 | 12 | hugo import from Jekyll 13 | 14 | ### Synopsis 15 | 16 | 17 | hugo import from Jekyll. 18 | 19 | Import from Jekyll requires two paths, e.g. `hugo import jekyll jekyll_root_path target_path`. 20 | 21 | ``` 22 | hugo import jekyll 23 | ``` 24 | 25 | ### Options 26 | 27 | ``` 28 | --force Allow import into non-empty target directory 29 | ``` 30 | 31 | ### Options inherited from parent commands 32 | 33 | ``` 34 | --config string config file (default is path/config.yaml|json|toml) 35 | --log Enable Logging 36 | --logFile string Log File path (if set, logging enabled automatically) 37 | --quiet build in quiet mode 38 | -v, --verbose verbose output 39 | --verboseLog verbose logging 40 | ``` 41 | 42 | ### SEE ALSO 43 | * [hugo import](/commands/hugo_import/) - Import your site from others. 44 | 45 | ###### Auto generated by spf13/cobra on 25-Feb-2017 46 | -------------------------------------------------------------------------------- /content/commands/hugo_list.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo list" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_list 8 | url: /commands/hugo_list/ 9 | --- 10 | ## hugo list 11 | 12 | Listing out various types of content 13 | 14 | ### Synopsis 15 | 16 | 17 | Listing out various types of content. 18 | 19 | List requires a subcommand, e.g. `hugo list drafts`. 20 | 21 | ### Options 22 | 23 | ``` 24 | -s, --source string filesystem path to read files relative from 25 | ``` 26 | 27 | ### Options inherited from parent commands 28 | 29 | ``` 30 | --config string config file (default is path/config.yaml|json|toml) 31 | --log Enable Logging 32 | --logFile string Log File path (if set, logging enabled automatically) 33 | --quiet build in quiet mode 34 | -v, --verbose verbose output 35 | --verboseLog verbose logging 36 | ``` 37 | 38 | ### SEE ALSO 39 | * [hugo](/commands/hugo/) - hugo builds your site 40 | * [hugo list drafts](/commands/hugo_list_drafts/) - List all drafts 41 | * [hugo list expired](/commands/hugo_list_expired/) - List all posts already expired 42 | * [hugo list future](/commands/hugo_list_future/) - List all posts dated in the future 43 | 44 | ###### Auto generated by spf13/cobra on 25-Feb-2017 45 | -------------------------------------------------------------------------------- /content/commands/hugo_list_drafts.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo list drafts" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_list_drafts 8 | url: /commands/hugo_list_drafts/ 9 | --- 10 | ## hugo list drafts 11 | 12 | List all drafts 13 | 14 | ### Synopsis 15 | 16 | 17 | List all of the drafts in your content directory. 18 | 19 | ``` 20 | hugo list drafts 21 | ``` 22 | 23 | ### Options inherited from parent commands 24 | 25 | ``` 26 | --config string config file (default is path/config.yaml|json|toml) 27 | --log Enable Logging 28 | --logFile string Log File path (if set, logging enabled automatically) 29 | --quiet build in quiet mode 30 | -s, --source string filesystem path to read files relative from 31 | -v, --verbose verbose output 32 | --verboseLog verbose logging 33 | ``` 34 | 35 | ### SEE ALSO 36 | * [hugo list](/commands/hugo_list/) - Listing out various types of content 37 | 38 | ###### Auto generated by spf13/cobra on 25-Feb-2017 39 | -------------------------------------------------------------------------------- /content/commands/hugo_list_expired.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo list expired" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_list_expired 8 | url: /commands/hugo_list_expired/ 9 | --- 10 | ## hugo list expired 11 | 12 | List all posts already expired 13 | 14 | ### Synopsis 15 | 16 | 17 | List all of the posts in your content directory which has already 18 | expired. 19 | 20 | ``` 21 | hugo list expired 22 | ``` 23 | 24 | ### Options inherited from parent commands 25 | 26 | ``` 27 | --config string config file (default is path/config.yaml|json|toml) 28 | --log Enable Logging 29 | --logFile string Log File path (if set, logging enabled automatically) 30 | --quiet build in quiet mode 31 | -s, --source string filesystem path to read files relative from 32 | -v, --verbose verbose output 33 | --verboseLog verbose logging 34 | ``` 35 | 36 | ### SEE ALSO 37 | * [hugo list](/commands/hugo_list/) - Listing out various types of content 38 | 39 | ###### Auto generated by spf13/cobra on 25-Feb-2017 40 | -------------------------------------------------------------------------------- /content/commands/hugo_list_future.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo list future" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_list_future 8 | url: /commands/hugo_list_future/ 9 | --- 10 | ## hugo list future 11 | 12 | List all posts dated in the future 13 | 14 | ### Synopsis 15 | 16 | 17 | List all of the posts in your content directory which will be 18 | posted in the future. 19 | 20 | ``` 21 | hugo list future 22 | ``` 23 | 24 | ### Options inherited from parent commands 25 | 26 | ``` 27 | --config string config file (default is path/config.yaml|json|toml) 28 | --log Enable Logging 29 | --logFile string Log File path (if set, logging enabled automatically) 30 | --quiet build in quiet mode 31 | -s, --source string filesystem path to read files relative from 32 | -v, --verbose verbose output 33 | --verboseLog verbose logging 34 | ``` 35 | 36 | ### SEE ALSO 37 | * [hugo list](/commands/hugo_list/) - Listing out various types of content 38 | 39 | ###### Auto generated by spf13/cobra on 25-Feb-2017 40 | -------------------------------------------------------------------------------- /content/commands/hugo_new.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo new" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_new 8 | url: /commands/hugo_new/ 9 | --- 10 | ## hugo new 11 | 12 | Create new content for your site 13 | 14 | ### Synopsis 15 | 16 | 17 | Create a new content file and automatically set the date and title. 18 | It will guess which kind of file to create based on the path provided. 19 | 20 | You can also specify the kind with `-k KIND`. 21 | 22 | If archetypes are provided in your theme or site, they will be used. 23 | 24 | ``` 25 | hugo new [path] 26 | ``` 27 | 28 | ### Options 29 | 30 | ``` 31 | --editor string edit new content with this editor, if provided 32 | -f, --format string frontmatter format (default "toml") 33 | -k, --kind string Content type to create 34 | -s, --source string filesystem path to read files relative from 35 | ``` 36 | 37 | ### Options inherited from parent commands 38 | 39 | ``` 40 | --config string config file (default is path/config.yaml|json|toml) 41 | --log Enable Logging 42 | --logFile string Log File path (if set, logging enabled automatically) 43 | --quiet build in quiet mode 44 | -v, --verbose verbose output 45 | --verboseLog verbose logging 46 | ``` 47 | 48 | ### SEE ALSO 49 | * [hugo](/commands/hugo/) - hugo builds your site 50 | * [hugo new site](/commands/hugo_new_site/) - Create a new site (skeleton) 51 | * [hugo new theme](/commands/hugo_new_theme/) - Create a new theme 52 | 53 | ###### Auto generated by spf13/cobra on 25-Feb-2017 54 | -------------------------------------------------------------------------------- /content/commands/hugo_new_site.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo new site" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_new_site 8 | url: /commands/hugo_new_site/ 9 | --- 10 | ## hugo new site 11 | 12 | Create a new site (skeleton) 13 | 14 | ### Synopsis 15 | 16 | 17 | Create a new site in the provided directory. 18 | The new site will have the correct structure, but no content or theme yet. 19 | Use `hugo new [contentPath]` to create new content. 20 | 21 | ``` 22 | hugo new site [path] 23 | ``` 24 | 25 | ### Options 26 | 27 | ``` 28 | --force Init inside non-empty directory 29 | -f, --format string config & frontmatter format (default "toml") 30 | ``` 31 | 32 | ### Options inherited from parent commands 33 | 34 | ``` 35 | --config string config file (default is path/config.yaml|json|toml) 36 | --log Enable Logging 37 | --logFile string Log File path (if set, logging enabled automatically) 38 | --quiet build in quiet mode 39 | -s, --source string filesystem path to read files relative from 40 | -v, --verbose verbose output 41 | --verboseLog verbose logging 42 | ``` 43 | 44 | ### SEE ALSO 45 | * [hugo new](/commands/hugo_new/) - Create new content for your site 46 | 47 | ###### Auto generated by spf13/cobra on 25-Feb-2017 48 | -------------------------------------------------------------------------------- /content/commands/hugo_new_theme.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo new theme" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_new_theme 8 | url: /commands/hugo_new_theme/ 9 | --- 10 | ## hugo new theme 11 | 12 | Create a new theme 13 | 14 | ### Synopsis 15 | 16 | 17 | Create a new theme (skeleton) called [name] in the current directory. 18 | New theme is a skeleton. Please add content to the touched files. Add your 19 | name to the copyright line in the license and adjust the theme.toml file 20 | as you see fit. 21 | 22 | ``` 23 | hugo new theme [name] 24 | ``` 25 | 26 | ### Options inherited from parent commands 27 | 28 | ``` 29 | --config string config file (default is path/config.yaml|json|toml) 30 | --log Enable Logging 31 | --logFile string Log File path (if set, logging enabled automatically) 32 | --quiet build in quiet mode 33 | -s, --source string filesystem path to read files relative from 34 | -v, --verbose verbose output 35 | --verboseLog verbose logging 36 | ``` 37 | 38 | ### SEE ALSO 39 | * [hugo new](/commands/hugo_new/) - Create new content for your site 40 | 41 | ###### Auto generated by spf13/cobra on 25-Feb-2017 42 | -------------------------------------------------------------------------------- /content/commands/hugo_undraft.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo undraft" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_undraft 8 | url: /commands/hugo_undraft/ 9 | --- 10 | ## hugo undraft 11 | 12 | Undraft changes the content's draft status from 'True' to 'False' 13 | 14 | ### Synopsis 15 | 16 | 17 | Undraft changes the content's draft status from 'True' to 'False' 18 | and updates the date to the current date and time. 19 | If the content's draft status is 'False', nothing is done. 20 | 21 | ``` 22 | hugo undraft path/to/content 23 | ``` 24 | 25 | ### Options inherited from parent commands 26 | 27 | ``` 28 | --config string config file (default is path/config.yaml|json|toml) 29 | --log Enable Logging 30 | --logFile string Log File path (if set, logging enabled automatically) 31 | --quiet build in quiet mode 32 | -v, --verbose verbose output 33 | --verboseLog verbose logging 34 | ``` 35 | 36 | ### SEE ALSO 37 | * [hugo](/commands/hugo/) - hugo builds your site 38 | 39 | ###### Auto generated by spf13/cobra on 25-Feb-2017 40 | -------------------------------------------------------------------------------- /content/commands/hugo_version.md: -------------------------------------------------------------------------------- 1 | --- 2 | date: 2017-02-25T10:01:37+01:00 3 | title: "hugo version" 4 | menu: 5 | docs: 6 | parent: "commands" 7 | slug: hugo_version 8 | url: /commands/hugo_version/ 9 | --- 10 | ## hugo version 11 | 12 | Print the version number of Hugo 13 | 14 | ### Synopsis 15 | 16 | 17 | All software has versions. This is Hugo's. 18 | 19 | ``` 20 | hugo version 21 | ``` 22 | 23 | ### Options inherited from parent commands 24 | 25 | ``` 26 | --config string config file (default is path/config.yaml|json|toml) 27 | --log Enable Logging 28 | --logFile string Log File path (if set, logging enabled automatically) 29 | --quiet build in quiet mode 30 | -v, --verbose verbose output 31 | --verboseLog verbose logging 32 | ``` 33 | 34 | ### SEE ALSO 35 | * [hugo](/commands/hugo/) - hugo builds your site 36 | 37 | ###### Auto generated by spf13/cobra on 25-Feb-2017 38 | -------------------------------------------------------------------------------- /content/content-management/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Content Management 3 | linktitle: Content Management Overview 4 | description: Hugo makes managing large static sites easy with support for archetypes, content types, menus, cross references, summaries, and more. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | menu: 9 | docs: 10 | parent: "content-management" 11 | weight: 1 12 | tags: [source, organization] 13 | categories: [content management] 14 | weight: 01 #rem 15 | draft: false 16 | aliases: [/content/] 17 | toc: false 18 | --- 19 | 20 | A static site generator needs to extend beyond front matter and a couple templates to be both scalable and *manageable*. Hugo was designed with not only developers in mind, but also content managers and authors. 21 | -------------------------------------------------------------------------------- /content/contribute/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Contributing to the Hugo Project 3 | linktitle: Contributing to Hugo 4 | description: Contribute to Hugo development and documentation. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [contribute] 9 | tags: [] 10 | menu: 11 | docs: 12 | parent: "contribute" 13 | weight: 01 14 | weight: 01 #rem 15 | draft: false 16 | slug: 17 | aliases: [/tutorials/how-to-contribute-to-hugo/,/community/contributing/] 18 | toc: false 19 | --- 20 | 21 | Hugo relies heavily on the enthusiasm and participation of the open-source community. We need your support in both its development and documentation. 22 | 23 | Hugo's contribution guidelines are [detailed in a `CONTRIBUTING.md`](https://github.com/spf13/hugo/blob/master/CONTRIBUTING.md) in the Hugo source repository on GitHub. 24 | -------------------------------------------------------------------------------- /content/documentation.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Hugo Documentation 3 | linktitle: Hugo 4 | description: Hugo is the world's fastest static website engine. It's written in Golang and developed by spf13 and friends. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | menu: 9 | main: 10 | parent: "section name" 11 | weight: 01 12 | weight: 01 #rem 13 | draft: false 14 | slug: 15 | aliases: [] 16 | toc: false 17 | layout: documentation-home 18 | --- 19 | Hugo is the world's fastest static website engine. It's written in Golang and developed by spf13 and friends. Below you will find some of the most common and helpful pages from our documentation. 20 | -------------------------------------------------------------------------------- /content/functions/GetPage.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: getpage 3 | linktitle: GetPage 4 | description: Looks up the index page (`_index.md`) of a given `Kind` and `path`. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [sections,lists,indexes] 14 | ns: 15 | signature: ["GetPage TYPE PATH"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | 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. 24 | 25 | `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 homepage or a section, from a template: 26 | 27 | ``` 28 | {{ with .Site.GetPage "section" "blog" }}{{ .Title }}{{ end }} 29 | ``` 30 | 31 | 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. 32 | 33 | The valid page kinds are: *home, section, taxonomy and taxonomyTerm.* 34 | 35 | ## `.GetPage` Example 36 | 37 | This code snippet---in the form of a [partial template][partials]---allows you to do the following: 38 | 39 | 1. Grab the index object of your `tags` [taxonomy][]. 40 | 2. Assign this object to a variable, `$t` 41 | 3. Sort the terms associated with the taxonomy by popularity. 42 | 4. Grab the top two most popular terms in the taxonomy (i.e., the two most popular tags assigned to content. 43 | 44 | {{% code file="grab-top-two-tags.html" %}} 45 | ```html 46 | 52 | ``` 53 | {{% /code %}} 54 | 55 | 56 | [partials]: /templates/partials/ 57 | [taxonomy]: /content-management/taxonomies/ 58 | -------------------------------------------------------------------------------- /content/functions/NumFmt.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: numfmt 3 | linktitle: NumFmt 4 | description: "Formats a number with a given precision using the requested `decimal`, `grouping`, and `negative` characters." 5 | godocref: "" 6 | workson: [] 7 | date: 2017-02-01 8 | publishdate: 2017-02-01 9 | lastmod: 2017-02-01 10 | categories: [functions] 11 | tags: [numbers] 12 | menu: 13 | docs: 14 | parent: "functions" 15 | toc: false 16 | ns: "lang" 17 | signature: ["NumFmt "] 18 | workson: [] 19 | hugoversion: 20 | relatedfuncs: [] 21 | deprecated: false 22 | draft: false 23 | aliases: [] 24 | comments: 25 | --- 26 | 27 | `lang.NumFmt` formats a number with a given precision using the requested `decimal`, `grouping`, and `negative` characters. The default options value is `- . ,`. 28 | 29 | Numbers greater than or equal to 5 are rounded up. For example, if precision is set to `0`, `1.5` becomes `2`, and `1.4` becomes `1`. 30 | 31 | ``` 32 | {{ lang.NumFmt "," "." "-" 2 12345.6789 }} → 12.345,68 33 | {{ lang.NumFmt "." "" "-" 6 -12345.6789 }} → -12345.678900 34 | {{ lang.NumFmt "." "," "-" 0 -12345.6789 }} → -12,346 35 | {{ -98765.4321 | lang.NumFmt "." "," "-" 2 }} → -98,765.43 36 | ``` 37 | -------------------------------------------------------------------------------- /content/functions/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Functions Quick Reference 3 | linktitle: Functions Quick Reference 4 | description: Comprehensive list of Hugo templating functions, including basic and advanced usage examples. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | tags: [] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | weight: 01 #rem 14 | draft: false 15 | aliases: [/layout/functions/] 16 | --- 17 | 18 | Go templates are lightweight but extensible. Go itself supplies built-in functions, including comparison operators and other basic tools. These are listed in the [Go template documentation][gofuncs]. Hugo has added additional functions to the basic template logic. 19 | 20 | [gofuncs]: http://golang.org/pkg/text/template/#hdr-Functions 21 | -------------------------------------------------------------------------------- /content/functions/abslangurl.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: abslangurl 3 | linktitle: absLangURL 4 | description: Adds the absolute URL with correct language prefix according to site configuration for multilingual. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [multilingual,i18n,urls] 14 | ns: 15 | signature: ["absLangURL INPUT"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [relLangURL] 19 | deprecated: false 20 | aliases: [] 21 | needsexamples: true 22 | --- 23 | 24 | Both `absLangURL` and [`relLangURL`](/functions/rellangurl/) are similar to their [`absURL`](/functions/absurl/) and [`relURL`](/functions/relurl) relatives but will add the correct language prefix when the site is configured with more than one language. 25 | 26 | So for a site `baseURL` set to `http://yoursite.com/hugo/` and the current language is `en`: 27 | 28 | ```golang 29 | {{ "blog/" | absLangURL }} → "http://yoursite.com/hugo/en/blog/" 30 | {{ "blog/" | relLangURL }} → "/hugo/en/blog/" 31 | ``` 32 | -------------------------------------------------------------------------------- /content/functions/absurl.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: absurl 3 | linktitle: absURL 4 | description: Given a string, prepends the full absolute URL according to position in file structure and the configured baseURL. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [urls] 14 | ns: 15 | signature: ["absURL INPUT"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [relURL] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `http://yoursite.com/hugo/`: 24 | 25 | ```golang 26 | {{ "mystyle.css" | absURL }} → "http://yoursite.com/hugo/mystyle.css" 27 | {{ "mystyle.css" | relURL }} → "/hugo/mystyle.css" 28 | {{ "http://gohugo.io/" | relURL }} → "http://gohugo.io/" 29 | {{ "http://gohugo.io/" | absURL }} → "http://gohugo.io/" 30 | ``` 31 | 32 | The last two examples may look strange but can be very useful. For example, the following shows how to use `absURL` in [JSON-LD structured data (SEO)][jsonld], where some of your images for a piece of content may or may not be hosted locally: 33 | 34 | {{% code file="layouts/partials/schemaorg-metadata.html" download="schemaorg-metadata.html" %}} 35 | ```html 36 | 43 | ``` 44 | {{% /code %}} 45 | 46 | The above uses the [apply function][] and also exposes how the Go template parser JSON-encodes objects inside ` 43 | ``` 44 | {{% /code %}} 45 | 46 | The above uses the [apply function][] and also exposes how the Go template parser JSON-encodes objects inside `` → `` 33 | * `` → `` 34 | 35 | -------------------------------------------------------------------------------- /content/functions/seq.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: seq 3 | # linktitle: 4 | description: Creates a sequence of integers. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [] 14 | ns: 15 | signature: ["seq LAST", "seq FIRST LAST", "seq FIRST INCREMENT LAST"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | draft: false 21 | aliases: [] 22 | --- 23 | 24 | `seq` creates a sequence of integers. It's named and used in the model of [GNU's seq][]. 25 | 26 | ``` 27 | 3 → 1, 2, 3 28 | 1 2 4 → 1, 3 29 | -3 → -1, -2, -3 30 | 1 4 → 1, 2, 3, 4 31 | 1 -2 → 1, 0, -1, -2 32 | ``` 33 | 34 | ## Example: `seq` with `range` and `after` 35 | 36 | You can use `seq` in combination with `range` and `after`. The following will return 19 elements: 37 | 38 | ```golang 39 | {{ range after 1 (seq 20)}} 40 | {{ end }} 41 | ``` 42 | 43 | However, when ranging with an index, the following may be less confusing in that `$indexStartingAt1` and `$num` will return `1,2,3 ... 20`: 44 | 45 | ```golang 46 | {{ range $index, $num := (seq 20) }} 47 | $indexStartingAt1 := (add $index 1) 48 | {{ end }} 49 | ``` 50 | 51 | 52 | [GNU's seq]: http://www.gnu.org/software/coreutils/manual/html_node/seq-invocation.html#seq-invocation 53 | -------------------------------------------------------------------------------- /content/functions/sha.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: sha 3 | # linktitle: sha 4 | description: Hashes the given input and returns either an SHA1 or SHA256 checksum. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [sha,checksum] 14 | ns: 15 | signature: ["sha1 INPUT", "sha256 INPUT"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | `sha1` hashes the given input and returns its SHA1 checksum. 24 | 25 | ```html 26 | {{ sha1 "Hello world, gophers!" }} 27 | 28 | ``` 29 | 30 | `sha256` hashes the given input and returns its SHA256 checksum. 31 | 32 | ```html 33 | {{ sha256 "Hello world, gophers!" }} 34 | 35 | ``` 36 | -------------------------------------------------------------------------------- /content/functions/shuffle.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: shuffle 3 | # linktitle: 4 | description: Returns a random permutation of a given array or slice. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-04-30 9 | tags: [ordering] 10 | categories: [functions] 11 | menu: 12 | docs: 13 | parent: "functions" 14 | ns: 15 | signature: ["shuffle COLLECTION"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [seq] 19 | deprecated: false 20 | draft: false 21 | aliases: [] 22 | needsexamples: true 23 | --- 24 | 25 | `shuffle` returns a random permutation of a given array or slice: 26 | 27 | {{% code file="shuffle-input.html" %}} 28 | ```html 29 | 30 |
{{ shuffle (seq 1 5) }}
31 | 32 |
{{ shuffle (slice "foo" "bar" "buzz") }}
33 | ``` 34 | {{% /code %}} 35 | 36 | This example would return the following: 37 | 38 | {{% output file="shuffle-output.html" %}} 39 | ```html 40 | 41 |
2 5 3 1 4
42 | 43 |
buzz foo bar
44 | ``` 45 | {{% /output %}} 46 | 47 | This example also makes use of the [slice](/functions/slice/) and [seq](/functions/seq/) functions. 48 | -------------------------------------------------------------------------------- /content/functions/singularize.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: singularize 3 | # linktitle: singularize 4 | description: Converts a word according to a set of common English singularization rules. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [strings,singular] 14 | ns: 15 | signature: ["singularize INPUT"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | `singularize` converts a word according to a set of common English singularization rules. 24 | 25 | `{{ "cats" | singularize }}` → "cat" 26 | 27 | See also the `.Data.Singular` [taxonomy variable](/variables/taxonomy/) for singularizing taxonomy names. 28 | 29 | -------------------------------------------------------------------------------- /content/functions/slice.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: slice 3 | # linktitle: slice 4 | description: Creates an array (`[]interface{}``) of all passed arguments. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [slice, array, interface] 14 | ns: 15 | signature: ["slice ITEM..."] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | draft: false 21 | aliases: [] 22 | toc: false 23 | needsexamples: true 24 | --- 25 | 26 | `slice` allows you to create an array (`[]interface{}`) of all arguments that you pass to this function. 27 | 28 | One use case is the concatenation of elements in combination with the [`delimit` function][]: 29 | 30 | {{% code file="slice.html" %}} 31 | ```html 32 | {{ delimit (slice "foo" "bar" "buzz") ", " }} 33 | 34 | ``` 35 | {{% /code %}} 36 | 37 | 38 | [`delimit` function]: /functions/delimit/ 39 | -------------------------------------------------------------------------------- /content/functions/slicestr.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: slicestr 3 | # linktitle: 4 | description: Creates a slice of a half-open range, including start and end indices. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [strings] 14 | ns: 15 | signature: ["slicestr STRING START [END]"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | Slicing in `slicestr` is done by specifying a half-open range with two indices; i.e., a `start` and and `end`. 24 | 25 | For example, 1 and 4 creates a slice including elements 1 through 3. 26 | The `end` index can be omitted; it defaults to the string's length. 27 | 28 | * `{{slicestr "BatMan" 3}}` → "Man" 29 | * `{{slicestr "BatMan" 0 3}}` → "Bat" 30 | 31 | -------------------------------------------------------------------------------- /content/functions/sort.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: sort 3 | # linktitle: sort 4 | description: Sorts maps, arrays, and slices and returns a sorted slice. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [ordering,sorting,lists] 14 | ns: 15 | signature: [] 16 | workson: [lists,taxonomies,terms,groups] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | `sort` sorts maps, arrays, and slices and returns a sorted slice. A sorted array of map values will be returned with the keys eliminated. There are two optional arguments: `sortByField` and `sortAsc`. If left blank, sort will sort by keys (for maps) in ascending order as its default behavior. 24 | 25 | ```toml 26 | +++ 27 | tags: [ "tag3", "tag1", "tag2" ] 28 | +++ 29 | 30 | // Site config 31 | +++ 32 | [params.authors] 33 | [params.authors.Derek] 34 | "firstName" = "Derek" 35 | "lastName" = "Perkins" 36 | [params.authors.Joe] 37 | "firstName" = "Joe" 38 | "lastName" = "Bergevin" 39 | [params.authors.Tanner] 40 | "firstName" = "Tanner" 41 | "lastName" = "Linsley" 42 | +++ 43 | ``` 44 | 45 | ``` 46 | // Use default sort options - sort by key / ascending 47 | Tags: {{ range sort .Params.tags }}{{ . }} {{ end }} 48 | 49 | → Outputs Tags: tag1 tag2 tag3 50 | 51 | // Sort by value / descending 52 | Tags: {{ range sort .Params.tags "value" "desc" }}{{ . }} {{ end }} 53 | 54 | → Outputs Tags: tag3 tag2 tag1 55 | 56 | // Use default sort options - sort by value / descending 57 | Authors: {{ range sort .Site.Params.authors }}{{ .firstName }} {{ end }} 58 | 59 | → Outputs Authors: Derek Joe Tanner 60 | 61 | // Use default sort options - sort by value / descending 62 | Authors: {{ range sort .Site.Params.authors "lastName" "desc" }}{{ .lastName }} {{ end }} 63 | 64 | → Outputs Authors: Perkins Linsley Bergevin 65 | ``` 66 | 67 | -------------------------------------------------------------------------------- /content/functions/split.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: split 3 | # linktitle: split 4 | description: splits a string into substrings separated by a delimiter 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [strings] 14 | ns: 15 | signature: ["split STRING DELIM"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | `split` splits a string into substrings separated by a delimiter. 24 | 25 | * `{{split "tag1,tag2,tag3" "," }}` → ["tag1" "tag2" "tag3"] 26 | 27 | 28 | -------------------------------------------------------------------------------- /content/functions/string.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: string 3 | # linktitle: string 4 | description: Creates a string from the argument passed to the function 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [strings] 14 | ns: 15 | signature: ["string INPUT"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | `string` creates a string from the argument passed to the function. 24 | 25 | * `{{string "BatMan"}}` → "BatMan" 26 | 27 | -------------------------------------------------------------------------------- /content/functions/substr.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: substr 3 | # linktitle: 4 | description: Extracts parts of a string from a specified character's position and returns the specified number of characters. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [strings] 14 | aliases: [] 15 | ns: 16 | signature: ["substr STRING START [LENGTH]"] 17 | workson: [] 18 | hugoversion: 19 | relatedfuncs: [] 20 | deprecated: false 21 | --- 22 | 23 | `substr` extracts parts of a string, beginning at the character at the specified position, and returns the specified number of characters. 24 | 25 | 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. 26 | 27 | To extract characters from the end of the string, use a negative start number. 28 | 29 | In addition, borrowing from the extended behavior described at http://php.net substr, if `length` is given and is negative, that number of characters will be omitted from the end of string. 30 | 31 | ``` 32 | {{substr "BatMan" 0 -3}} → "Bat" 33 | {{substr "BatMan" 3 3}} → "Man" 34 | ``` 35 | -------------------------------------------------------------------------------- /content/functions/time.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: time 3 | # linktitle: 4 | description: Converts a timestamp string into a `time.Time` structure. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [dates,time] 14 | ns: 15 | signature: ["time INPUT"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | `time` converts a timestamp string into a [`time.Time`](https://godoc.org/time#Time) structure so you can access its fields: 24 | 25 | ``` 26 | {{ time "2016-05-28" }} → "2016-05-28T00:00:00Z" 27 | {{ (time "2016-05-28").YearDay }} → 149 28 | {{ mul 1000 (time "2016-05-28T10:30:00.00+10:00").Unix }} → 1464395400000, or Unix time in milliseconds 29 | ``` 30 | -------------------------------------------------------------------------------- /content/functions/title.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: title 3 | # linktitle: 4 | description: Converts all characters in the provided string to title case. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [fundamentals,strings] 14 | ns: 15 | signature: ["title INPUT"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | 24 | `title` converts all characters in the provided string to title case. 25 | 26 | ``` 27 | {{title "BatMan"}}` → "Batman" 28 | ``` 29 | -------------------------------------------------------------------------------- /content/functions/trim.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: trim 3 | # linktitle: 4 | description: Returns a slice of a passed string with all leading and trailing characters from cutset removed. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [strings] 14 | ns: 15 | signature: ["trim INPUT CUTSET"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | --- 21 | 22 | `trim` returns a slice of the string with all leading and trailing characters contained in cutset removed. 23 | 24 | ``` 25 | {{ trim "++Batman--" "+-" }} → "Batman" 26 | ``` 27 | 28 | `trim` *requires* the second argument, which tells the function specifically what to remove from the first argument. There is no default value for the second argument, so **the following usage will not work**: 29 | 30 | ``` 31 | {{ trim .Inner}} 32 | ``` 33 | 34 | Instead, the following example tells `trim` to remove extra new lines from the content contained in the [shortcode `.Inner` variable][shortcodevars]: 35 | 36 | ``` 37 | {{ trim .Inner "\n" }} 38 | ``` 39 | 40 | {{% note %}} 41 | Go templates also provide a simple [method for trimming whitespace](/templates/introduction/#whitespace) from either side of a Go tag by including a hyphen (`-`). 42 | {{% /note %}} 43 | 44 | 45 | [shortcodevars]: /variables/shortcodes/ -------------------------------------------------------------------------------- /content/functions/truncate.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: truncate 3 | # linktitle: truncate 4 | description: Truncates a text to a max length without cutting words or leaving unclosed HTML tags. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [strings] 14 | ns: 15 | signature: ["truncate SIZE INPUT", "truncate SIZE ELLIPSIS INPUT"] 16 | workson: [] 17 | hugoversion: 19 18 | relatedfuncs: [] 19 | deprecated: false 20 | --- 21 | 22 | Truncate a text to a max length without cutting words or leaving unclosed HTML tags. Since Go templates are HTML-aware, `truncate` will intelligently handle normal strings vs HTML strings: 23 | 24 | ``` 25 | {{ "Keep my HTML" | safeHTML | truncate 10 }}` → Keep my …` 26 | ``` 27 | 28 | {{% note %}} 29 | If you have a raw string that contains HTML tags you want to remain treated as HTML, you will need to convert the string to HTML using the [`safeHTML` template function](/functions/safehtml) before sending the value to truncate. Otherwise, the HTML tags will be escaped when passed through the `truncate` function. 30 | {{% /note %}} 31 | -------------------------------------------------------------------------------- /content/functions/union.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: union 3 | # linktitle: union 4 | description: Given two arrays or slices, returns a new array that contains the elements or objects that belong to either or both arrays/slices. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-03-12 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [filtering,lists] 14 | ns: 15 | signature: ["union SET1 SET2"] 16 | workson: [] 17 | hugoversion: 0.20 18 | relatedfuncs: [intersect,where] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | Given two arrays (or slices) A and B, this function will return a new array that contains the elements or objects that belong to either A or to B or to both. The elements supported are strings, integers, and floats (only float64). 24 | 25 | ```golang 26 | {{ union (slice 1 2 3) (slice 3 4 5) }} 27 | 28 | 29 | {{ union (slice 1 2 3) nil }} 30 | 31 | 32 | {{ union nil (slice 1 2 3) }} 33 | 34 | 35 | {{ union nil nil }} 36 | 37 | ``` 38 | -------------------------------------------------------------------------------- /content/functions/uniq.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: uniq 3 | linktitle: uniq 4 | description: Takes in a slice or array and returns a slice with subsequent duplicate elements removed. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [multilingual,i18n,urls] 14 | ns: 15 | signature: ["uniq SET"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | aliases: [] 21 | needsexamples: false 22 | --- 23 | 24 | The `uniq` function takes in a slice or array and returns a slice with subsequent duplicate elements removed: 25 | 26 | ```html 27 | {{ uniq (slice 1 2 3 2) }} 28 | {{ slice 1 2 3 2 | uniq }} 29 | 30 | ``` 31 | 32 | 33 | 34 | 35 | -------------------------------------------------------------------------------- /content/functions/unix.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: unix 3 | # linktitle: Unix 4 | description: Unix returns the local Time corresponding to the given Unix time, sec seconds and nsec nanoseconds since January 1, 1970 UTC. 5 | godocref: https://golang.org/search?q=Unix#Functions 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | tags: [dates,time] 10 | categories: [functions] 11 | menu: 12 | docs: 13 | parent: "functions" 14 | ns: 15 | signature: ["Unix"] 16 | workson: [times] 17 | hugoversion: 18 | relatedfuncs: [Format,dateFormat,now,time] 19 | deprecated: false 20 | aliases: [] 21 | --- 22 | 23 | `Unix` returns t as a Unix time; i.e., the number of seconds elapsed since January 1, 1970 UTC. 24 | 25 | ## `Unix` Example 1: Show Only Upcoming Events 26 | 27 | The following assumes you have a content section called `events` (i.e., `content/events/*.md`). The following [partial template][] allows you to only list events that haven't occurred yet. 28 | 29 | {{% code file="layouts/partials/upcoming-events.html" download="upcoming-events.html" %}} 30 | ```html 31 |

Upcoming Events

32 |
    33 | {{ range where .Data.Pages.ByDate "Section" "events" }} 34 | {{ if ge .Date.Unix .Now.Unix }} 35 |
  • {{ .Type | title }} — 36 | {{ .Title }} 37 | on 38 | {{ .Date.Format "2 January at 3:04pm" }} 39 | at {{ .Params.place }} 40 |
    • 41 | {{ end }} 42 | {{ end }} 43 |
44 | ``` 45 | {{% /code %}} 46 | 47 | ## `Unix` Example 2: Time Passed Since Last Modification 48 | 49 | This very simple one-liner uses `Unix` with `Now` to calculate the amount of time that has passed between the `.LastMod` for the current page and the last build of the current page. 50 | 51 | {{% code file="time-passed.html" %}} 52 | ```golang 53 | {{ div (sub .Now.Unix .Lastmod.Unix) 86400 }} 54 | ``` 55 | {{% /code %}} 56 | 57 | Since both values are integers, they can be subtracted and then divided by the number of seconds in a day (i.e., `60 * 60 * 24 == 86400`). 58 | 59 | {{% note %}} 60 | Hugo's output is *static*. In example 2, a month-old page published on a Hugo site that only publishes monthly could easily misrepresented the last update as *yesterday* rather than 30 days ago. 61 | {{% /note %}} 62 | 63 | 64 | 65 | [partial template]: /templates/partials/ 66 | -------------------------------------------------------------------------------- /content/functions/upper.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: upper 3 | # linktitle: upper 4 | description: Converts all characters in a string to uppercase 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | tags: [] 10 | categories: [functions] 11 | menu: 12 | docs: 13 | parent: "functions" 14 | toc: 15 | ns: 16 | signature: ["upper INPUT"] 17 | workson: [] 18 | hugoversion: 19 | relatedfuncs: [] 20 | deprecated: false 21 | draft: false 22 | aliases: [] 23 | --- 24 | 25 | `upper` converts all characters in string to uppercase. Note that `upper` can be applied in your templates in more than one way: 26 | 27 | ``` 28 | {{ upper "BatMan" }} → "BATMAN" 29 | {{ "BatMan" | upper }} → "BATMAN" 30 | ``` 31 | 32 | -------------------------------------------------------------------------------- /content/functions/urlize.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: urlize 3 | # linktitle: urlize 4 | description: Takes a string, sanitizes it for usage in URLs, and converts spaces to hyphens. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [functions] 9 | menu: 10 | docs: 11 | parent: "functions" 12 | tags: [urls,strings] 13 | godocref: 14 | ns: 15 | signature: ["urlize INPUT"] 16 | hugoversion: 17 | deprecated: false 18 | workson: [] 19 | relatedfuncs: [] 20 | --- 21 | 22 | `urlize` takes a string, sanitizes it for usage in URLs, and converts spaces to hyphens ("`-`"). 23 | 24 | The following examples pull from a content file with the following front matter: 25 | 26 | {{% code file="content/blog/greatest-city.md" copy="false"%}} 27 | ```toml 28 | +++ 29 | title = "The World's Greatest City" 30 | location = "Chicago IL" 31 | tags = ["pizza","beer","hot dogs"] 32 | +++ 33 | ``` 34 | {{% /code %}} 35 | 36 | The following might be used as a partial within a [single page template][singletemplate]: 37 | 38 | {{% code file="layouts/partials/content-header.html" download="content-header.html" %}} 39 | ```html 40 |
41 |

{{.Title}}

42 | {{ with .Params.location }} 43 | 44 | {{ end }} 45 | 46 | {{ with .Params.tags }} 47 |
    48 | {{range .}} 49 |
  • 50 | {{ . }} 51 |
    • 52 | {{end}} 53 |
54 | {{ end }} 55 |
56 | ``` 57 | {{% /code %}} 58 | 59 | The preceding partial would then output to the rendered page as follows, assuming the page is being built with Hugo's default pretty URLs. 60 | 61 | {{% output file="/blog/greatest-city/index.html" %}} 62 | ```html 63 |
64 |

The World's Greatest City

65 | 66 | 77 |
78 | ``` 79 | {{% /output %}} 80 | 81 | 82 | [singletemplate]: /templates/single-page-templates/ 83 | -------------------------------------------------------------------------------- /content/functions/with.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: with 3 | # linktitle: with 4 | description: Rebinds the context (`.`) within its scope and skips the block if the variable is absent. 5 | godocref: 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-03-12 9 | categories: [functions] 10 | menu: 11 | docs: 12 | parent: "functions" 13 | tags: [conditionals,fundamentals] 14 | ns: 15 | signature: ["with INPUT"] 16 | workson: [] 17 | hugoversion: 18 | relatedfuncs: [] 19 | deprecated: false 20 | --- 21 | 22 | An alternative way of writing an `if` statement 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 or unset. 23 | 24 | The following example checks for a [user-defined site variable](/variables/site/) called `twitteruser`. If the key-value is not set, the following will render nothing: 25 | 26 | {{% code file="layouts/partials/twitter.html" %}} 27 | ```html 28 | {{with .Site.Params.twitteruser}}{{end}} 33 | ``` 34 | {{% /code %}} 35 | -------------------------------------------------------------------------------- /content/getting-started/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Getting Started 3 | linktitle: Getting Started Overview 4 | description: Quick start and guides for installing Hugo on your preferred operating system. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [getting started] 9 | tags: [usage,docs] 10 | menu: 11 | docs: 12 | parent: "getting-started" 13 | weight: 1 14 | weight: 0001 #rem 15 | draft: false 16 | aliases: [/overview/introduction/] 17 | toc: false 18 | --- 19 | 20 | If this is your first time using Hugo and you've [already installed Hugo on your machine][installed], we recommend the [quick start][]. 21 | 22 | [installed]: /getting-started/installing/ 23 | [quick start]: /getting-started/quick-start/ 24 | -------------------------------------------------------------------------------- /content/hosting-and-deployment/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Hosting & Deployment 3 | linktitle: Hosting & Deployment Overview 4 | description: Site builds, automated deployments, and popular hosting solutions. 5 | date: 2016-11-01 6 | publishdate: 2016-11-01 7 | lastmod: 2016-11-01 8 | categories: [hosting and deployment] 9 | tags: [] 10 | menu: 11 | docs: 12 | parent: "hosting-and-deployment" 13 | weight: 01 14 | weight: 01 #rem 15 | draft: false 16 | aliases: [] 17 | toc: false 18 | --- 19 | 20 | Because Hugo renders *static* websites, you can host your new Hugo website virtually anywhere. The following represent only a few of the more popular hosting and automated deployment solutions used by the Hugo community. 21 | -------------------------------------------------------------------------------- /content/mailing-list.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Mailing List 3 | linktitle: Mailing List 4 | description: Join the Hugo mailing list for updates on the project. The mailing list has very low traffic and only sends release-related email. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | weight: 01 #rem 9 | categories: [] 10 | tags: [mailing list, community] 11 | draft: true 12 | aliases: [/community/mailing-list/] 13 | toc: false 14 | --- 15 | 16 | ## Discussion Forum 17 | 18 | Hugo has its own [discussion forum](http://discourse.gohugo.io/) powered by [Discourse](http://www.discourse.org/). 19 | 20 | Please use this for all discussions, questions, etc. 21 | 22 | ## Mailing List 23 | 24 | Hugo has two mailing lists: 25 | 26 | ### Announcements 27 | 28 | Very low traffic. Only releases will be emailed here. 29 | 30 | 31 | 32 | ### Discussion Forum (Archived) 33 | 34 | {{% note %}} 35 | This has been replaced with the [Hugo discussion forum](http://discourse.gohugo.io/) and is available for archival purposes only. 36 | {{% /note %}} 37 | 38 | You can find the old Hugo discussion forum at . 39 | 40 | ## Other Resources 41 | 42 | ### GoNuts 43 | 44 | For general Go questions or discussion please refer to the Go mailing list. 45 | 46 | https://groups.google.com/forum/#!forum/golang-nuts 47 | 48 | ### GitHub Issues 49 | 50 | https://github.com/spf13/hugo/issues 51 | 52 | ### Twitter 53 | 54 | The Official Hugo Twitter Account: [@GoHugoIO](https://twitter.com/GoHugoIO) 55 | Steve Francia: [@spf13](https://twitter.com/spf13). 56 | Bjørn Erik Pedersen: [@bepsays](https://twitter.com/bepsays) 57 | -------------------------------------------------------------------------------- /content/news/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Hugo News" 3 | --- 4 | -------------------------------------------------------------------------------- /content/news/press-and-articles.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Press and Articles 3 | linktitle: Press and Articles 4 | description: A list of articles, blog posts, or tutorials where Hugo is featured. 5 | date: 2016-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | tags: [articles, tutorials, press] 9 | categories: [news and articles] 10 | menu: 11 | main: 12 | parent: "News" 13 | weight: 30 14 | weight: 30 15 | sections_weight: 30 16 | draft: false 17 | aliases: [/community/press/] 18 | toc: false 19 | notesforauthors: "If adding an item to the articles list, be sure to follow the format of '| [Linked Title]() | Author Name | YYYY-MM-DD |'." 20 | --- 21 | 22 | {{% note "Help Keep This List Up to Date" %}} 23 | Know of a post, article, or tutorial on Hugo? [Please add it to this list](https://github.com/spf13/hugo/edit/master/docs/content/news/press-and-articles.md). 24 | {{% /note %}} 25 | 26 | Hugo has been featured in the following Blog Posts, Press, and Media. 27 | 28 | {{< articlelist >}} 29 | -------------------------------------------------------------------------------- /content/readfiles/README.md: -------------------------------------------------------------------------------- 1 | # readdirs Directory for Reusable Content 2 | 3 | Files in this directory are: 4 | 5 | 1. Used in *more than one place* within the Hugo docs 6 | 2. Used in Examples of readdir (i.e. in local file templates) 7 | 8 | These files are called using the [`readfile` shortcode (source)](../layouts/readfile.html). 9 | 10 | You can call this shortcode in the docs as follows: 11 | 12 | 13 | {{% readfile file="/path/to/file.txt" markdown="true" %}} 14 | 15 | 16 | `markdown="true"` is optional (default = `"false"`) and parses the string through the Blackfriday renderer. 17 | -------------------------------------------------------------------------------- /content/readfiles/menuvars.md: -------------------------------------------------------------------------------- 1 | `.URL` 2 | : string 3 | 4 | `.Name` 5 | : string 6 | 7 | `.Menu` 8 | : string 9 | 10 | `.Identifier` 11 | : string 12 | 13 | `.Pre` 14 | : template.HTML 15 | 16 | `.Post` 17 | : template.HTML 18 | 19 | `.Weight` 20 | : int 21 | 22 | `.Parent` 23 | : string 24 | 25 | `.Children` 26 | : Menu 27 | 28 | Note that menus also have the following functions available as well: 29 | 30 | [`.HasChildren`](/functions/haschildren/) 31 | : boolean 32 | 33 | Additionally, there are some relevant functions available to menus on a page: 34 | 35 | [`.IsMenuCurrent`](/functions/ismenucurrent/) 36 | : (menu string, menuEntry *MenuEntry ) boolean 37 | 38 | [`.HasMenuCurrent`](/functions/hasmenucurrent/) 39 | : (menu string, menuEntry *MenuEntry) boolean -------------------------------------------------------------------------------- /content/readfiles/testing.txt: -------------------------------------------------------------------------------- 1 | ##### Hello World! 2 | 3 | Testing one, **two**, *three*. Don't delete this sample file used in the [templates](/templates/) section of the Hugo docs. -------------------------------------------------------------------------------- /content/templates/404.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Custom 404 Page 3 | linktitle: 404 Page 4 | description: If you know how to create a single page template, you have unlimited options for creating a custom 404. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-03-31 8 | categories: [templates] 9 | tags: [404, page not found] 10 | menu: 11 | docs: 12 | parent: "templates" 13 | weight: 120 14 | weight: 120 #rem 15 | draft: false 16 | aliases: [/templates/404/] 17 | toc: false 18 | --- 19 | 20 | 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. 21 | 22 | 404 pages will have all the regular [page variables][pagevars] available to use in the templates. 23 | 24 | In addition to the standard page variables, the 404 page has access to all site content accessible from `.Data.Pages`. 25 | 26 | ```bash 27 | ▾ layouts/ 28 | 404.html 29 | ``` 30 | 31 | ## 404.html 32 | 33 | This is a basic example of a 404.html template: 34 | 35 | {{% code file="layouts/404.html" download="404.html" %}} 36 | ```html 37 | {{ define "main"}} 38 |
39 |
40 |

Go Home

41 |
42 |
43 | {{ end }} 44 | ``` 45 | {{% /code %}} 46 | 47 | ## Automatic Loading 48 | 49 | 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: 50 | 51 | * [GitHub Pages](/hosting-and-deployment/hosting-on-github/). The 404 page is automatic. 52 | * Apache. You can specify `ErrorDocument 404 /404.html` in an `.htaccess` file in the root of your site. 53 | * Nginx. You might specify `error_page 404 /404.html;` in your `nginx.conf` file. 54 | * Amazon AWS S3. When setting a bucket up for static web serving, you can specify the error file from within the S3 GUI. 55 | * Caddy Server. Using `errors { 404 /404.html }`. [Details here](https://caddyserver.com/docs/errors) 56 | 57 | [pagevars]: /variables/page/ -------------------------------------------------------------------------------- /content/templates/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Templates 3 | linktitle: Templates Overview 4 | description: Golang templating, template types and lookup order, shortcodes, and data. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | menu: 9 | docs: 10 | parent: "templates" 11 | weight: 01 12 | weight: 01 #rem 13 | categories: [templates] 14 | tags: [] 15 | draft: false 16 | aliases: [/templates/overview/] 17 | toc: false 18 | notesforauthors: 19 | --- 20 | -------------------------------------------------------------------------------- /content/templates/robots.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Robots.txt File 3 | linktitle: Robots.txt 4 | description: Hugo can generate a customized robots.txt in the same way as any other template. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [templates] 9 | tags: [robots,search engines] 10 | menu: 11 | docs: 12 | parent: "templates" 13 | weight: 165 14 | weight: 165 15 | sections_weight: 165 16 | draft: false 17 | aliases: [/extras/robots-txt/] 18 | toc: false 19 | --- 20 | 21 | Hugo can generate a customized [robots.txt][robots] in the same way as any other template. 22 | 23 | To create your robots.txt as a template, first set the `enableRobotsTXT` value to `true` in your [configuration file][config]. By default, this option generates a robots.txt with the following content, which tells search engines that they are allowed to crawl everything: 24 | 25 | ```http 26 | User-agent: * 27 | ``` 28 | 29 | ## Robots.txt Template Lookup Order 30 | 31 | The [lookup order][lookup] for the `robots.txt` template is as follows: 32 | 33 | * `/layouts/robots.txt` 34 | * `/themes//layout/robots.txt` 35 | 36 | {{% note %}} 37 | If you do not want Hugo to create a default `robots.txt` or leverage the `robots.txt` template, you can hand code your own and place the file in `static`. Remember that everything in the [static directory](/getting-started/directory-structure/) is copied over as-is when Hugo builds your site. 38 | {{% /note %}} 39 | 40 | ## Robots.txt Template Example 41 | 42 | The following is an example `robots.txt` layout: 43 | 44 | {{% code file="layouts/robots.txt" download="robots.txt" %}} 45 | ```http 46 | User-agent: * 47 | 48 | {{range .Data.Pages}} 49 | Disallow: {{.RelPermalink}} 50 | {{end}} 51 | ``` 52 | {{% /code %}} 53 | 54 | This template disallows all the pages of the site by creating one `Disallow` entry for each page. 55 | 56 | [config]: /getting-started/configuration/ 57 | [lookup]: /templates/lookup-order/ 58 | [robots]: http://www.robotstxt.org/ -------------------------------------------------------------------------------- /content/templates/template-debugging.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Template Debugging 3 | # linktitle: Template Debugging 4 | description: You can use Go templates' `printf` function to debug your Hugo templates. These snippets provide a quick and easy visualization of the variables available to you in different contexts. 5 | godocref: http://golang.org/pkg/fmt/ 6 | date: 2017-02-01 7 | publishdate: 2017-02-01 8 | lastmod: 2017-02-01 9 | categories: [templates] 10 | tags: [debugging,troubleshooting] 11 | menu: 12 | docs: 13 | parent: "templates" 14 | weight: 180 15 | weight: 180 16 | sections_weight: 180 17 | draft: false 18 | aliases: [] 19 | toc: false 20 | --- 21 | 22 | Here are some snippets you can add to your template to answer some common questions. 23 | 24 | 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/). 25 | 26 | ## What Variables are Available in this Context? 27 | 28 | 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`. 29 | 30 | ```html 31 | {{ printf "%#v" $.Site }} 32 | ``` 33 | 34 | This will print out the value of `.Permalink`: 35 | 36 | 37 | ```html 38 | {{ printf "%#v" .Permalink }} 39 | ``` 40 | 41 | 42 | This will print out a list of all the variables scoped to the current context 43 | (`.`, aka ["the dot"][tempintro]). 44 | 45 | 46 | ```html 47 | {{ printf "%#v" . }} 48 | ``` 49 | 50 | 51 | When developing a [homepage][], what does one of the pages you're looping through look like? 52 | 53 | ```html 54 | {{ range .Data.Pages }} 55 | {{/* The context, ".", is now each one of the pages as it goes through the loop */}} 56 | {{ printf "%#v" . }} 57 | {{ end }} 58 | ``` 59 | 60 | {{% note "`.Data.Pages` on the Homepage" %}} 61 | `.Data.Pages` on the homepage is equivalent to `.Site.Pages`. 62 | {{% /note %}} 63 | 64 | ## Why Am I Showing No Defined Variables? 65 | 66 | Check that you are passing variables in the `partial` function: 67 | 68 | ```html 69 | {{ partial "header" }} 70 | ``` 71 | 72 | This example will render the header partial, but the header partial will not have access to any contextual variables. You need to pass variables explicitly. For example, note the addition of ["the dot"][tempintro]. 73 | 74 | ```html 75 | {{ partial "header" . }} 76 | ``` 77 | 78 | The dot (`.`) is considered fundamental to understanding Hugo templating. For more information, see [Introduction to Hugo Templating][tempintro]. 79 | 80 | [homepage]: /templates/homepage/ 81 | [tempintro]: /templates/introduction/ -------------------------------------------------------------------------------- /content/themes/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Themes 3 | linktitle: Themes Overview 4 | description: Install, use, and create Hugo themes. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | menu: 9 | docs: 10 | parent: "themes" 11 | weight: 01 12 | weight: 01 13 | sections_weight: 01 14 | categories: [themes] 15 | tags: [themes,introduction,overview] 16 | draft: false 17 | aliases: [/themes/overview/] 18 | toc: false 19 | --- 20 | 21 | Hugo provides a robust theming system that is easy to implement but capable of producing even the most complicated websites. You can view the themes created by the Hugo community on the [Hugo themes website][hugothemes]. 22 | 23 | Hugo themes are powered by the excellent Go template library and are designed to reduce code duplication. They are easy to simultaneously customize while retaining upgradability with the upstream theme. 24 | 25 | [goprimer]: /templates/introduction/ 26 | [hugothemes]: http://themes.gohugo.io/ 27 | -------------------------------------------------------------------------------- /content/tools/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Developer Tools 3 | linktitle: Developer Tools Overview 4 | description: In addition to Hugo's powerful CLI, there is a large number of community-developed tool chains for Hugo developers. 5 | date: 2016-12-05 6 | publishdate: 2016-12-05 7 | lastmod: 2017-02-26 8 | categories: [developer tools] 9 | tags: [] 10 | menu: 11 | docs: 12 | parent: "tools" 13 | weight: 01 14 | weight: 01 15 | sections_weight: 01 16 | draft: false 17 | aliases: [/tools/] 18 | --- 19 | 20 | One of Hugo's greatest strengths is it's passionate---and always evolving---developer community. With the exception of the `highlight` shortcode mentioned in [Syntax Highlighting][syntax], the tools and other projects featured in this section are offerings from both commercial services and open-source projects, many of which are developed by Hugo developers just like you. 21 | 22 | [See the popularity of Hugo compared with other static site generators.][staticgen] 23 | 24 | [staticgen]: https://staticgen.com 25 | [syntax]: /tools/syntax-highlighting/ 26 | -------------------------------------------------------------------------------- /content/tools/editors.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Editor Plug-ins for Hugo 3 | linktitle: Editor Plug-ins 4 | description: The Hugo community uses a wide range of preferred tools and has developed plug-ins for some of the most popular text editors to help automate parts of your workflow. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [developer tools] 9 | tags: [editor, plug-ins] 10 | menu: 11 | docs: 12 | parent: "tools" 13 | weight: 50 14 | weight: 50 15 | sections_weight: 50 16 | draft: false 17 | aliases: [] 18 | toc: false 19 | --- 20 | 21 | The Hugo community uses a wide range of preferred tools and has developed plug-ins for some of the most popular text editors to help automate parts of your workflow. 22 | 23 | ## Sublime Text 24 | 25 | * [Hugofy](https://github.com/akmittal/Hugofy). Hugofy is a plugin for Sublime Text 3 to make life easier to use Hugo static site generator. 26 | 27 | ## Visual Studio Code 28 | 29 | * [Hugofy](https://marketplace.visualstudio.com/items?itemName=akmittal.hugofy). Hugofy is a plugin for Visual Studio Code to "make life easier" when developing with Hugo. The source code can be found [here](https://github.com/akmittal/hugofy-vscode). 30 | 31 | ## Emacs 32 | 33 | * [hugo.el](https://github.com/yewton/hugo.el). Some helper functions for creating a Website with Hugo. Note that Hugo also supports [Org-mode][formats]. 34 | 35 | ## Vim 36 | 37 | * [Vim Hugo Helper](https://github.com/robertbasic/vim-hugo-helper). A small Vim plugin to help me with writing posts with Hugo. 38 | 39 | ## Atom 40 | 41 | * [Hugofy](https://atom.io/packages/hugofy). A Hugo Static Website Generator package for Atom. 42 | * [language-hugo](https://atom.io/packages/language-hugo). Adds syntax highlighting to Hugo files. 43 | 44 | [formats]: /content-management/formats/ -------------------------------------------------------------------------------- /content/tools/other.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Other Hugo Community Projects 3 | linktitle: Other Projects 4 | description: Some interesting projects developed by the Hugo community that don't quite fit into our other developer tool categories. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [developer tools] 9 | tags: [frontend,gui] 10 | menu: 11 | docs: 12 | parent: "tools" 13 | weight: 70 14 | weight: 70 15 | sections_weight: 70 16 | draft: false 17 | aliases: [] 18 | toc: false 19 | --- 20 | 21 | And for all the other small things around Hugo: 22 | 23 | * [hugo-gallery](https://github.com/icecreammatt/hugo-gallery) lets you create an image gallery for Hugo sites. 24 | * [flickr-hugo-embed](https://github.com/nikhilm/flickr-hugo-embed) prints shortcodes to embed a set of images from an album on Flickr into Hugo. 25 | * [hugo-openapispec-shortcode](https://github.com/tenfourty/hugo-openapispec-shortcode) A shortcode that allows you to include [Open API Spec](https://openapis.org) (formerly known as Swagger Spec) in a page. 26 | * [HugoPhotoSwipe](https://github.com/GjjvdBurg/HugoPhotoSwipe) makes it easy to create image galleries using PhotoSwipe. 27 | * [Hugo SFTP Upload](https://github.com/thomasmey/HugoSftpUpload) Syncs the local build of your Hugo website with your remote webserver via SFTP. 28 | * [Emacs Easy Hugo](https://github.com/masasam/emacs-easy-hugo) Emacs package for writing blog posts in markdown or org-mode and building your site with Hugo. 29 | -------------------------------------------------------------------------------- /content/tools/search.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Search for your Hugo Website 3 | linktitle: Search 4 | description: See some of the open-source and commercial search options for your newly created Hugo website. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-26 8 | categories: [developer tools] 9 | tags: [search,tools] 10 | menu: 11 | docs: 12 | parent: "tools" 13 | weight: 60 14 | weight: 60 15 | sections_weight: 60 16 | draft: false 17 | aliases: [] 18 | toc: true 19 | --- 20 | 21 | A static website with a dynamic search function? Yes. As alternatives to embeddable scripts from Google or other search engines, you can provide your visitors a custom search by indexing your content files directly. 22 | 23 | * [Hugoidx](https://github.com/blevesearch/hugoidx) is an experimental application to create a search index. It's built on top of [Bleve](http://www.blevesearch.com/). 24 | * [GitHub Gist for Hugo Workflow](https://gist.github.com/sebz/efddfc8fdcb6b480f567). This gist contains a simple workflow to create a search index for your static website. It uses a simple Grunt script to index all your content files and [lunr.js](http://lunrjs.com/) to serve the search results. 25 | * [hugo-lunr](https://www.npmjs.com/package/hugo-lunr). A simple way to add site search to your static Hugo site using [lunr.js](http://lunrjs.com/). Hugo-lunr will create an index file of any html and markdown documents in your Hugo project. 26 | 27 | ## Commercial Search Services 28 | 29 | * [Algolia](https://www.algolia.com/)'s Search API makes it easy to deliver a great search experience in your apps and websites. Algolia Search provides hosted full-text, numerical, faceted, and geolocalized search. -------------------------------------------------------------------------------- /content/tools/starter-kits.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Starter Kits 3 | linktitle: Starter Kits 4 | description: A list of community-developed projects designed to help you get up and running with Hugo. 5 | date: 2017-02-22 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-22 8 | tags: [starters,assets,pipeline] 9 | menu: 10 | docs: 11 | parent: "tools" 12 | weight: 30 13 | weight: 30 14 | sections_weight: 30 15 | draft: false 16 | aliases: [/developer-tools/migrations/,/developer-tools/migrated/] 17 | toc: false 18 | --- 19 | 20 | Know of a Hugo-related starter kit that isn't mentioned here? [Please add it to the list.][addkit] 21 | 22 | {{% note "Starter Kits are Not Maintained by the Hugo Team"%}} 23 | The following starter kits are developed by active members of the Hugo community. If you find yourself having issues with any of the projects, it's best to file an issue directly with the project's maintainer(s). 24 | {{% /note %}} 25 | 26 | * [Victor Hugo][]. Victor Hugo is a Hugo boilerplate for creating truly epic websites using Gulp + Webpack as an asset pipeline. Victor Hugo uses post-css and Babel for CSS and JavaScript, respectively, and is actively maintained. 27 | * [GOHUGO AMP][]. GoHugo AMP is a starter theme that aims to make it easy to adopt [Google's AMP Project][amp]. The starter kit comes with 40+ shortcodes and partials plus automatic structured data. The project also includes a [separate site with extensive documentation][gohugodocs]. 28 | * [Blaupause][]. Blaupause is a developer-friendly Hugo starter kit based on Gulp tasks. It comes ES6-ready with several helpers for SVG and fonts and basic structure for HTML, SCSS, and JavaScript. 29 | * [hugulp][]. hugulp is a tool to optimize the assets of a Hugo website. The main idea is to recreate the famous Ruby on Rails Asset Pipeline, which minifies, concatenates and fingerprints the assets used in your website. 30 | 31 | 32 | [addkit]: https://github.com/spf13/hugo/edit/master/docs/content/tools/starter-kits.md 33 | [amp]: https://www.ampproject.org/ 34 | [Blaupause]: https://github.com/fspoettel/blaupause 35 | [GOHUGO AMP]: https://github.com/wildhaber/gohugo-amp 36 | [gohugodocs]: https://gohugo-amp.gohugohq.com/ 37 | [hugulp]: https://github.com/jbrodriguez/hugulp 38 | [Victor Hugo]: https://github.com/netlify/victor-hugo -------------------------------------------------------------------------------- /content/troubleshooting/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Troubleshooting 3 | linktitle: Troubleshooting 4 | description: Frequently asked questions and known issues pulled from the Hugo Discuss forum. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | menu: 9 | docs: 10 | parent: "troubleshooting" 11 | weight: 01 12 | weight: 01 #rem 13 | draft: false 14 | hidesectioncontents: false 15 | slug: 16 | aliases: [/troubleshooting/faqs/,/faqs/] 17 | toc: false 18 | notesforauthors: 19 | --- 20 | 21 | The Troubleshooting section includes known issues, recent workarounds, and FAQs pulled from the [Hugo Discussion Forum][forum]. 22 | 23 | 24 | 25 | 26 | [forum]: https://discourse.gohugo.io 27 | -------------------------------------------------------------------------------- /content/troubleshooting/build-performance.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Build Performance 3 | linktitle: Build Performance 4 | description: 5 | date: 2017-03-12 6 | publishdate: 2017-03-12 7 | lastmod: 2017-03-12 8 | tags: [performance, build] 9 | categories: [troubleshooting] 10 | menu: 11 | docs: 12 | parent: "troubleshooting" 13 | weight: 14 | draft: true 15 | slug: 16 | aliases: [] 17 | toc: true 18 | wip: true 19 | --- 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /content/troubleshooting/eof-error.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: EOF Error 3 | linktitle: EOF Error 4 | description: If you find yourself seeing an EOF error in the console whenever you create a new content file from Hugo's archetype feature. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [troubleshooting] 9 | menu: 10 | docs: 11 | parent: "troubleshooting" 12 | tags: [eof, end of file, error, faqs] 13 | draft: false 14 | weight: 15 | aliases: [/troubleshooting/strange-eof-error/] 16 | toc: true 17 | --- 18 | 19 | ## Trouble: `hugo new` Aborts with EOF error 20 | 21 | > I'm running into an issue where I cannot get archetypes working, when running `hugo new showcase/test.md`, for example, I see an `EOF` error thrown by Hugo. 22 | > 23 | > When I run Hugo with v0.12 via `hugo new -v showcase/test.md`, I see the following output: 24 | > 25 | > ```bash 26 | > INFO: 2015/01/04 Using config file: /private/tmp/test/config.toml 27 | > INFO: 2015/01/04 attempting to create showcase/test.md of showcase 28 | > INFO: 2015/01/04 curpath: /private/tmp/test/archetypes/showcase.md 29 | > ERROR: 2015/01/04 EOF 30 | > ``` 31 | > 32 | > Is there something that I am blatantly missing? 33 | 34 | ## Solution: Carriage Returns 35 | 36 | The solution is to add a final newline (i.e., `EOL`) to the end of your default.md archetype file of your theme. You can do this by adding a carriage return after the closing `+++` or `---` of your TOML or YAML front matter, respectively. 37 | 38 | {{% note "Final EOL Unnecessary in v0.13+" %}} 39 | As of v0.13, Hugo's parser has been enhanced to accommodate archetype files without final EOL thanks to the great work by [@tatsushid](https://github.com/tatsushid). 40 | {{% /note %}} 41 | 42 | ## Discussion Forum References 43 | 44 | * http://discourse.gohugo.io/t/archetypes-not-properly-working-in-0-12/544 45 | * http://discourse.gohugo.io/t/eol-f-in-archetype-files/554 46 | 47 | ## Related Hugo Issues 48 | 49 | * https://github.com/spf13/hugo/issues/776 50 | -------------------------------------------------------------------------------- /content/variables/_index.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Variables and Params 3 | linktitle: Variables Overview 4 | description: Page-, file-, taxonomy-, and site-level variables and parameters available in templates. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [variables and params] 9 | tags: [variables,params,values,globals] 10 | draft: false 11 | menu: 12 | docs: 13 | parent: "variables" 14 | weight: 1 15 | weight: 01 #rem 16 | sections_weight: 01 17 | aliases: [/templates/variables/] 18 | toc: false 19 | --- 20 | 21 | Hugo's templates are context aware and make a large number of values available to you as you're creating views for your website. 22 | 23 | [Go templates]: /templates/introduction/ "Understand context in Go templates by learning the language's fundamental templating functions." 24 | -------------------------------------------------------------------------------- /content/variables/files.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: File Variables 3 | linktitle: 4 | description: Hugo provides the ability to traverse your website's files on your server, including the local Hugo server. 5 | date: 2017-02-01 6 | publishdate: 2017-02-01 7 | lastmod: 2017-02-01 8 | categories: [variables and params] 9 | tags: [files] 10 | draft: false 11 | menu: 12 | docs: 13 | parent: "variables" 14 | weight: 40 15 | weight: 40 16 | sections_weight: 40 17 | aliases: [/variables/file-variables/] 18 | toc: false 19 | --- 20 | 21 | Hugo provides the ability to traverse your website's files on your server, including the local `Hugo server`. You can access file-system-related data for a piece of content via the `.File` variable. 22 | 23 | {{% note "Rendering Local Files" %}} 24 | For information on creating shortcodes and templates that tap into Hugo's file-related feature set, see [Local File Templates](/templates/files/). 25 | {{% /note %}} 26 | 27 | The `.File` object contains the following fields: 28 | 29 | `.File.Path` 30 | : the original relative path of the page (e.g., `content/posts/foo.en.md`) 31 | 32 | `.File.LogicalName` 33 | : the name of the content file that represents a page (e.g., `foo.en.md`) 34 | 35 | `.File.TranslationBaseName` 36 | : the filename without extension or optional language identifier (e.g., `foo`) 37 | 38 | `.File.BaseFileName` 39 | : the filename without extension (e.g., `foo.en`) 40 | 41 | `.File.Ext` 42 | : the file extension of the content file (e.g., `md`); this can also be called using `.File.Extension` as well. Note that it is *only* the extension without `.`. 43 | 44 | `.File.Lang` 45 | : the language associated with the given file if Hugo's [Multilingual features][multilingual] are enabled (e.g., `en`) 46 | 47 | `.File.Dir` 48 | : given the path `content/posts/dir1/dir2/`, the relative directory path of the content file will be returned (e.g., `posts/dir1/dir2/`) 49 | 50 | [Multilingual]: /content-management/multilingual/ -------------------------------------------------------------------------------- /content/variables/git.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Git Info Variables 3 | linktitle: Git Variables 4 | description: 5 | date: 2017-03-12 6 | publishdate: 2017-03-12 7 | lastmod: 2017-03-12 8 | categories: [variables and params] 9 | tags: [git] 10 | draft: false 11 | menu: 12 | docs: 13 | parent: "variables" 14 | weight: 70 15 | weight: 70 16 | sections_weight: 70 17 | aliases: [/extras/gitinfo/] 18 | toc: false 19 | wip: false 20 | --- 21 | 22 | Hugo provides a way to integrate Git data into your website. 23 | 24 | {{% note "`.GitInfo` Performance Considerations" %}} 25 | Hugo's Git integrations should be fairly performant but *can* increase your build time. This will depend on the size of your Git history. 26 | {{% /note %}} 27 | 28 | ## `.GitInfo` Prerequisites 29 | 30 | 1. The Hugo site must be in a Git-enabled directory. 31 | 2. The Git executable must be installed and in your system `PATH`. 32 | 3. The `.GitInfo` feature must be enabled in your Hugo project by passing `--enableGitInfo` flag on the command line or by setting `enableGitInfo` to `true` in your [site's configuration file][configuration]. 33 | 34 | ## The `.GitInfo` Object 35 | 36 | The `GitInfo` object contains the following fields: 37 | 38 | `.AbbreviatedHash` 39 | : the abbreviated commit hash (e.g., `866cbcc`) 40 | 41 | `.AuthorName` 42 | : the author's name, respecting `.mailmap` 43 | 44 | `.AuthorEmail` 45 | : the author's email address, respecting `.mailmap` 46 | 47 | `.AuthorDate` 48 | : the author date 49 | 50 | `.Hash` 51 | : the commit hash (e.g., `866cbccdab588b9908887ffd3b4f2667e94090c3`) 52 | 53 | `.Subject` 54 | : commit message subject (e.g., `tpl: Add custom index function`) 55 | 56 | [configuration]: /getting-started/configuration/ 57 | -------------------------------------------------------------------------------- /content/variables/hugo.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Hugo-specific Variables 3 | linktitle: Hugo Variables 4 | description: Hugo variables can be used in your templates to show metadata such as Hugo version and commit hashes. 5 | date: 2017-03-12 6 | publishdate: 2017-03-12 7 | lastmod: 2017-03-12 8 | categories: [variables and params] 9 | tags: [hugo,generator] 10 | draft: false 11 | menu: 12 | docs: 13 | parent: "variables" 14 | weight: 60 15 | weight: 60 16 | sections_weight: 60 17 | aliases: [] 18 | toc: false 19 | wip: false 20 | --- 21 | 22 | The `.Hugo` variable provides easy access to Hugo-related data and contains the following fields: 23 | 24 | `.Hugo.Generator` 25 | : `` tag for the version of Hugo that generated the site. `.Hugo.Generator` outputs a *complete* HTML tag; e.g. `` 26 | 27 | `.Hugo.Version` 28 | : the current version of the Hugo binary you are using e.g. `0.13-DEV`
29 | 30 | `.Hugo.CommitHash` 31 | : the git commit hash of the current Hugo binary e.g. `0e8bed9ccffba0df554728b46c5bbf6d78ae5247` 32 | 33 | `.Hugo.BuildDate` 34 | : the compile date of the current Hugo binary formatted with RFC 3339 e.g. `2002-10-02T10:00:00-05:00`
35 | 36 | {{% note "Use the Hugo Generator Tag" %}} 37 | We highly recommend using `.Hugo.Generator` in your website's ``. `.Hugo.Generator` is included by default in all themes hosted on [themes.gohugo.io](http://themes.gohugo.io). The generator tag allows the Hugo team to track the usage and popularity of Hugo. 38 | {{% /note %}} 39 | 40 | -------------------------------------------------------------------------------- /content/variables/menus.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Menu Variables 3 | linktitle: Menu Variables 4 | description: A menu entry in a menu template has specific variables and functions to make menu management easier. 5 | date: 2017-03-12 6 | publishdate: 2017-03-12 7 | lastmod: 2017-03-12 8 | categories: [variables and params] 9 | tags: [menus] 10 | draft: false 11 | menu: 12 | docs: 13 | parent: "variables" 14 | weight: 50 15 | weight: 50 16 | sections_weight: 50 17 | aliases: [/variables/menu/] 18 | toc: false 19 | --- 20 | 21 | A menu entry in a [menu template][] has the following properties: 22 | 23 | `.URL` 24 | : string 25 | 26 | `.Name` 27 | : string 28 | 29 | `.Menu` 30 | : string 31 | 32 | `.Identifier` 33 | : string 34 | 35 | `.Pre` 36 | : template.HTML 37 | 38 | `.Post` 39 | : template.HTML 40 | 41 | `.Weight` 42 | : int 43 | 44 | `.Parent` 45 | : string 46 | 47 | `.Children` 48 | : Menu 49 | 50 | [menu template]: /templates/menu-templates/ -------------------------------------------------------------------------------- /content/variables/shortcodes.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Shortcode Variables 3 | linktitle: Shortcode Variables 4 | description: Shortcodes can access page variables and also have their own specific built-in variables. 5 | date: 2017-03-12 6 | publishdate: 2017-03-12 7 | lastmod: 2017-03-12 8 | categories: [variables and params] 9 | tags: [shortcodes] 10 | draft: false 11 | menu: 12 | docs: 13 | parent: "variables" 14 | weight: 20 15 | weight: 20 16 | sections_weight: 20 17 | aliases: [] 18 | toc: false 19 | --- 20 | 21 | [Shortcodes][shortcodes] have access to parameters delimited in the shortcode declaration via [`.Get`][getfunction], page- and site-level variables, and also the following shortcode-specific fields: 22 | 23 | `.Parent` 24 | : provides access to the parent shortcode context in nested shortcodes. This can be very useful for inheritance of common shortcode parameters from the root. 25 | 26 | `.IsNamedParams` 27 | : boolean that returns `true` when the shortcode in question uses [named rather than positional parameters][shortcodes] 28 | 29 | `.Inner` 30 | : represents the content between the opening and closing shortcode tags when a [closing shortcode][markdownshortcode] is used 31 | 32 | [getfunction]: /functions/get/ 33 | [markdownshortcode]: /content-management/shortcodes/#shortcodes-with-markdown 34 | [shortcodes]: /templates/shortcode-templates/ 35 | 36 | 37 | -------------------------------------------------------------------------------- /content/variables/sitemap.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Sitemap Variables 3 | linktitle: Sitemap Variables 4 | description: 5 | date: 2017-03-12 6 | publishdate: 2017-03-12 7 | lastmod: 2017-03-12 8 | categories: [variables and params] 9 | tags: [sitemap] 10 | draft: false 11 | menu: 12 | docs: 13 | parent: "variables" 14 | weight: 80 15 | weight: 80 16 | sections_weight: 80 17 | aliases: [] 18 | toc: false 19 | --- 20 | 21 | A sitemap is a `Page` and therefore has all the [page variables][pagevars] available to use sitemap templates. They also have the following sitemap-specific variables available to them: 22 | 23 | `.Sitemap.ChangeFreq` 24 | : the page change frequency 25 | 26 | `.Sitemap.Priority` 27 | : the priority of the page 28 | 29 | `.Sitemap.Filename` 30 | : the sitemap filename 31 | 32 | [pagevars]: /variables/page/ -------------------------------------------------------------------------------- /layouts/_default/baseof.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | Hugo Docs is Moving 11 | 67 | 68 | 69 | 70 |
71 | {{ block "main" . }} {{ partial "temp-closing.html" . }} {{ end }} 72 |
73 | 74 | 75 | 76 | -------------------------------------------------------------------------------- /layouts/_default/list.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ partial "temp-closing.html" . }} 3 | {{ end }} 4 | -------------------------------------------------------------------------------- /layouts/_default/single.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ partial "temp-closing.html" . }} 3 | {{ end }} 4 | -------------------------------------------------------------------------------- /layouts/_default/taxonomy.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ partial "temp-closing.html" . }} 3 | {{ end }} 4 | -------------------------------------------------------------------------------- /layouts/_default/terms.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ partial "temp-closing.html" . }} 3 | {{ end }} 4 | -------------------------------------------------------------------------------- /layouts/index.html: -------------------------------------------------------------------------------- 1 | {{ define "main" }} 2 | {{ end }} 3 | -------------------------------------------------------------------------------- /layouts/shortcodes/articlelist.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 8 | 9 | 10 | {{ range $ind, $art := $.Site.Data.articles.article }} 11 | 12 | 13 | 14 | 15 | 16 | {{ end }} 17 | 18 |
Title 5 | Author 6 | Date 7 |
{{$art.title | markdownify }}{{ $art.author | markdownify }}{{ $art.date }}
19 | -------------------------------------------------------------------------------- /layouts/shortcodes/code.html: -------------------------------------------------------------------------------- 1 |
2 | {{- with .Get "file" -}} 3 |
{{.}}
4 | {{- end -}} 5 | 6 | {{ if ne (.Get "copy") "false" }} 7 | 9 | {{/* Functionality located within filesaver.js The copy here is located in the css with .copy class so it can be replaced with JS on success */}} 10 | {{end}} 11 |
12 | {{- .Inner -}} 13 |
14 | 15 |
16 | -------------------------------------------------------------------------------- /layouts/shortcodes/datatable.html: -------------------------------------------------------------------------------- 1 | {{ $package := (index .Params 0) }} 2 | {{ $listname := (index .Params 1) }} 3 | {{ $list := (index (index .Site.Data.docs $package) $listname) }} 4 | {{ $fields := after 2 .Params }} 5 | 6 | 7 | 8 | {{ range $fields }} 9 | 10 | {{ end }} 11 | 12 | {{ range $list }} 13 | 14 | {{ range $k, $v := . }} 15 | {{ $.Scratch.Set $k $v }} 16 | {{ end }} 17 | {{ range $fields }} 18 | 19 | {{ end }} 20 | 21 | {{ end }} 22 |
{{ . }}
{{ $.Scratch.Get . }}
23 | -------------------------------------------------------------------------------- /layouts/shortcodes/directoryindex.html: -------------------------------------------------------------------------------- 1 | {{- $pathURL := .Get "pathURL" -}} 2 | {{- $path := .Get "path" -}} 3 | {{- $files := readDir $path -}} 4 | 5 | 6 | 7 | {{- range $files }} 8 | 9 | 10 | 11 | 12 | {{- end }} 13 |
Size in bytesName
{{ .Size }} {{ .Name }}
14 | -------------------------------------------------------------------------------- /layouts/shortcodes/docfile.html: -------------------------------------------------------------------------------- 1 | {{ $file := .Get 0}} 2 | {{ $filepath := $file }} 3 | {{ $syntax := index (split $file ".") 1 }} 4 | {{ $syntaxoverride := eq (len .Params) 2 }} 5 |
6 |
{{$filepath}}
7 | 10 | 
{{- readFile $file -}}
11 |
12 | -------------------------------------------------------------------------------- /layouts/shortcodes/exfile.html: -------------------------------------------------------------------------------- 1 | {{ $file := .Get 0}} 2 | {{ $filepath := replace $file "static/" ""}} 3 | {{ $syntax := index (split $file ".") 1 }} 4 | {{ $syntaxoverride := eq (len .Params) 2 }} 5 |
6 |
{{$filepath}}
7 | 10 | 
{{- readFile $file -}}
11 | Source 12 |
13 | -------------------------------------------------------------------------------- /layouts/shortcodes/exfm.html: -------------------------------------------------------------------------------- 1 | 2 | {{ $file := .Get 0}} 3 | {{ $filepath := replace $file "static/" ""}} 4 | {{ $syntax := index (split $file ".") 1 }} 5 | {{ $syntaxoverride := eq (len .Params) 2 }} 6 |
7 |
{{$filepath}}
8 | 11 | 
{{- readFile $file -}}
12 | Source 13 |
-------------------------------------------------------------------------------- /layouts/shortcodes/gh.html: -------------------------------------------------------------------------------- 1 | {{ range .Params }} 2 | {{ if eq (substr . 0 1) "@" }} 3 | {{ . }} 4 | {{ else if eq (substr . 0 2) "0x" }} 5 | {{ substr . 2 6 }} 6 | {{ else }} 7 | #{{ . }} 8 | {{ end }} 9 | {{ end }} -------------------------------------------------------------------------------- /layouts/shortcodes/ghrepo.html: -------------------------------------------------------------------------------- 1 | GitHub repository -------------------------------------------------------------------------------- /layouts/shortcodes/needsexamples.html: -------------------------------------------------------------------------------- 1 |
    2 | {{range .Site.Pages }} 3 | {{ if .Params.needsexamples }} 4 |
  • {{.Title}}
    • 5 | {{ end }} 6 | {{ end }} 7 |
-------------------------------------------------------------------------------- /layouts/shortcodes/nohighlight.html: -------------------------------------------------------------------------------- 1 | 
{{ .Inner }}
-------------------------------------------------------------------------------- /layouts/shortcodes/note.html: -------------------------------------------------------------------------------- 1 | 9 | -------------------------------------------------------------------------------- /layouts/shortcodes/output.html: -------------------------------------------------------------------------------- 1 | {{$file := .Get "file"}} 2 | {{$icon := index (split $file ".") 1 }} 3 |
4 |
{{$file}}
5 | 8 |
9 | {{- .Inner -}} 10 |
11 |
-------------------------------------------------------------------------------- /layouts/shortcodes/readfile.html: -------------------------------------------------------------------------------- 1 | {{$file := .Get "file"}} 2 | {{- if eq (.Get "markdown") "true" -}} 3 | {{- $file | readFile | markdownify -}} 4 | {{- else -}} 5 | {{ $file | readFile | safeHTML }} 6 | {{- end -}} -------------------------------------------------------------------------------- /layouts/shortcodes/tip.html: -------------------------------------------------------------------------------- 1 | 9 | -------------------------------------------------------------------------------- /layouts/shortcodes/warning.html: -------------------------------------------------------------------------------- 1 | 9 | -------------------------------------------------------------------------------- /layouts/shortcodes/yt.html: -------------------------------------------------------------------------------- 1 |
2 | 3 | {{if (.Get "thumbnail")}} 4 |
5 | {{else}} 6 |
7 | {{end}} 8 |
9 | {{ if (.Get "description") }} 10 |
{{ .Get "description" | markdownify }}
11 | {{ end }} -------------------------------------------------------------------------------- /static/_headers: -------------------------------------------------------------------------------- 1 | /* 2 | X-Frame-Options: DENY 3 | X-XSS-Protection: 1; mode=block 4 | X-Content-Type-Options: nosniff 5 | Referrer-Policy: origin-when-cross-origin 6 | -------------------------------------------------------------------------------- /static/contribute/development/accept-cla.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/contribute/development/accept-cla.png -------------------------------------------------------------------------------- /static/contribute/development/ci-errors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/contribute/development/ci-errors.png -------------------------------------------------------------------------------- /static/contribute/development/copy-remote-url.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/contribute/development/copy-remote-url.png -------------------------------------------------------------------------------- /static/contribute/development/forking-a-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/contribute/development/forking-a-repository.png -------------------------------------------------------------------------------- /static/contribute/development/open-pull-request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/contribute/development/open-pull-request.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/adding-a-github-pages-step.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/adding-a-github-pages-step.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/adding-the-project-to-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/adding-the-project-to-github.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/and-we-ve-got-an-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/and-we-ve-got-an-app.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/configure-the-deploy-step.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/configure-the-deploy-step.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/creating-a-basic-hugo-site.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/creating-a-basic-hugo-site.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/public-or-not.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/public-or-not.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/using-hugo-build.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/using-hugo-build.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-access.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-account-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-account-settings.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-add-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-add-app.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-git-connections.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-git-connections.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-search.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-select-owner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-select-owner.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-select-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-select-repository.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-sign-up-page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-sign-up-page.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/wercker-sign-up.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/wercker-sign-up.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/deployment-with-wercker/werckeryml.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/deployment-with-wercker/werckeryml.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-bitbucket/bitbucket-blog-post.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-bitbucket/bitbucket-blog-post.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-bitbucket/bitbucket-create-repo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-bitbucket/bitbucket-create-repo.png -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-add-new-site.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-add-new-site.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-authorize-added-permissions.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-authorize-added-permissions.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-1.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-2.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-3.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-3.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-deploy-published.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-deploy-published.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-deploying-site.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-deploying-site.gif -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-first-authorize.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-first-authorize.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-live-site.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-live-site.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-push-to-deploy.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-push-to-deploy.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/netlify-signup.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/netlify-signup.jpg -------------------------------------------------------------------------------- /static/hosting-and-deployment/hosting-on-netlify/tibobeijennl.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/hosting-and-deployment/hosting-on-netlify/tibobeijennl.jpg -------------------------------------------------------------------------------- /static/images/contribute/development/accept-cla.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/contribute/development/accept-cla.png -------------------------------------------------------------------------------- /static/images/contribute/development/ci-errors.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/contribute/development/ci-errors.png -------------------------------------------------------------------------------- /static/images/contribute/development/copy-remote-url.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/contribute/development/copy-remote-url.png -------------------------------------------------------------------------------- /static/images/contribute/development/forking-a-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/contribute/development/forking-a-repository.png -------------------------------------------------------------------------------- /static/images/contribute/development/open-pull-request.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/contribute/development/open-pull-request.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/adding-a-github-pages-step.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/adding-a-github-pages-step.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/adding-the-project-to-github.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/adding-the-project-to-github.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/and-we-ve-got-an-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/and-we-ve-got-an-app.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/configure-the-deploy-step.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/configure-the-deploy-step.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/creating-a-basic-hugo-site.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/creating-a-basic-hugo-site.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/public-or-not.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/public-or-not.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/using-hugo-build.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/using-hugo-build.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-access.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-access.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-account-settings.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-account-settings.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-add-app.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-add-app.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-git-connections.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-git-connections.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-search.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-search.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-select-owner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-select-owner.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-select-repository.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-select-repository.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-sign-up-page.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-sign-up-page.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/wercker-sign-up.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/wercker-sign-up.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/deployment-with-wercker/werckeryml.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/deployment-with-wercker/werckeryml.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-blog-post.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-blog-post.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-create-repo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-bitbucket/bitbucket-create-repo.png -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-add-new-site.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-add-new-site.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-authorize-added-permissions.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-authorize-added-permissions.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-1.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-1.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-2.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-2.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-3.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-create-new-site-step-3.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-deploy-published.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-deploy-published.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-deploying-site.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-deploying-site.gif -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-first-authorize.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-first-authorize.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-live-site.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-live-site.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-push-to-deploy.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-push-to-deploy.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/netlify-signup.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/netlify-signup.jpg -------------------------------------------------------------------------------- /static/images/hosting-and-deployment/hosting-on-netlify/tibobeijennl.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/hosting-and-deployment/hosting-on-netlify/tibobeijennl.jpg -------------------------------------------------------------------------------- /static/images/icon-custom-outputs.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /static/images/quickstart/bookshelf-bleak-theme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/bookshelf-bleak-theme.png -------------------------------------------------------------------------------- /static/images/quickstart/bookshelf-disqus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/bookshelf-disqus.png -------------------------------------------------------------------------------- /static/images/quickstart/bookshelf-new-default-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/bookshelf-new-default-image.png -------------------------------------------------------------------------------- /static/images/quickstart/bookshelf-only-picture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/bookshelf-only-picture.png -------------------------------------------------------------------------------- /static/images/quickstart/bookshelf-robust-theme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/bookshelf-robust-theme.png -------------------------------------------------------------------------------- /static/images/quickstart/bookshelf-updated-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/bookshelf-updated-config.png -------------------------------------------------------------------------------- /static/images/quickstart/bookshelf.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/bookshelf.png -------------------------------------------------------------------------------- /static/images/quickstart/default.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/default.jpg -------------------------------------------------------------------------------- /static/images/quickstart/gh-pages-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/images/quickstart/gh-pages-ui.png -------------------------------------------------------------------------------- /static/quickstart/bookshelf-bleak-theme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/bookshelf-bleak-theme.png -------------------------------------------------------------------------------- /static/quickstart/bookshelf-disqus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/bookshelf-disqus.png -------------------------------------------------------------------------------- /static/quickstart/bookshelf-new-default-image.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/bookshelf-new-default-image.png -------------------------------------------------------------------------------- /static/quickstart/bookshelf-only-picture.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/bookshelf-only-picture.png -------------------------------------------------------------------------------- /static/quickstart/bookshelf-robust-theme.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/bookshelf-robust-theme.png -------------------------------------------------------------------------------- /static/quickstart/bookshelf-updated-config.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/bookshelf-updated-config.png -------------------------------------------------------------------------------- /static/quickstart/bookshelf.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/bookshelf.png -------------------------------------------------------------------------------- /static/quickstart/default.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/default.jpg -------------------------------------------------------------------------------- /static/quickstart/gh-pages-ui.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/rdwatters/hugo-docs-concept/b6185dfb83d617f06a9671fae64ea0a0d484a4b9/static/quickstart/gh-pages-ui.png --------------------------------------------------------------------------------