diff --git a/config.toml b/config.toml index d2c5e1ff4..5d9372d9a 100644 --- a/config.toml +++ b/config.toml @@ -1,63 +1,53 @@ -baseurl = "/" -canonifyurls = true -# Pointing to this file -config = "config.toml" -enableGitInfo = true -paginate= 100 -copyright = "" +baseurl = "http://gohugo.io/" +paginate = 100 defaultContentLanguage = "en" -# Set to true to keep url path preserve casing (eg, for sections) -disablePathToLower = false -# Allows use of emoji shorthand directly in content enableEmoji = true # Set the unicode character used for the "return" link in page footnotes. footnotereturnlinkcontents = "↩" -# Create an array of files you don't want hugo to build -ignoreFiles = [] languageCode = "en-us" -# Enable Logging -log = true -# Log Filepath (if set, logging enabled automatically) -logFile = "" -# This accepts yaml, toml, or json metaDataFormat = "yaml" -# This intelligently adds an "s" to the titles of list pages -pluralizelisttitles = false -relativeURLs = true -# Display memory and timing of different steps of the program -stepAnalysis = true -# This is the top-level, global site title -title = "Hugo" +title = "Hugo: A Fast and Flexible Website Generator" theme = "gohugoioTheme" -# Change this once you've created your theme +googleAnalytics = "UA-7131036-4" + +pluralizeListTitles = false + +# We do redirects via Netlify's _redirects file, generated by Hugo (see "outputs" below). +disableAliases = true + +[outputs] +home = [ "HTML", "RSS", "REDIR" ] + +[mediaTypes] +[mediaTypes."text/netlify"] +suffix = "" +delimiter = "" + +[outputFormats] +[outputFormats.REDIR] +mediatype = "text/netlify" +baseName = "_redirects" +isPlainText = true +notAlternative = true -# Set to true to convert mysite/section/ to mysite/section.html -uglyURLs = false -verbose = false -verboseLog = false -# Setting this to false will keep hugo from watching for changes during local development -watch = true -# Add GA Tracking Code Here. This leverages a built-in (ie, "internal") partial from HUGO: https://gohugo.io/extras/analytics#configuring-google-analytics -googleAnalytics = "UA-76549364-1" [social] twitter = "GoHugoIO" - #CUSTOM PARAMS [params] description = "The world’s fastest framework for building websites" ## Used for views in rendered HTML (i.e., rather than using the .Hugo variable) - release = "0.20" + release = "Hugo-Next" ## Setting this to true will add a "noindex" to *EVERY* page on the site removefromexternalsearch = false ## This is used when the BaseURL does not need to modified (eg, in share links or in prerender, prefetch, etc to control for relativeURLs setting); do *not* include trailing slash siteaddress = "https://hugodocs.info" ## Gh repo for site footer (include trailing slash) - ghrepo = "https://github.com/gohugoio/hugo/" + ghrepo = "https://github.com/gohugoio/hugoDocs/" ### Edit content repo (set to automatically enter "edit" mode; this is good for "improve this page" links) - ghdocsrepo = "https://github.com/gohugoio/hugo/tree/master/docs" + ghdocsrepo = "https://github.com/gohugoio/hugoDocs/tree/master/docs" ## Gitter URL gitter = "https://gitter.im/spf13/hugo" ## Discuss Forum URL diff --git a/content/community/contributing.md b/content/community/contributing.md deleted file mode 100644 index 052311911..000000000 --- a/content/community/contributing.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -aliases: -- /doc/contributing/ -- /meta/contributing/ -lastmod: 2015-02-12 -date: 2013-07-01 -menu: - main: - parent: community -next: /tutorials/automated-deployments -prev: /community/mailing-list -title: Contributing to Hugo -weight: 30 ---- - -All contributions to Hugo are welcome. Whether you want to scratch an itch or simply contribute to the project, feel free to pick something from the [roadmap]({{< relref "meta/roadmap.md" >}}) or contact the dev team via the [Forums](https://discourse.gohugo.io/) or [Gitter](https://gitter.im/gohugoio/hugo) about what may make sense to do next. - -You should fork the project and make your changes. *We encourage pull requests to discuss code changes.* - - -When you're ready to create a pull request, be sure to: - - * Have test cases for the new code. If you have questions about how to do it, please ask in your pull request. - * Run `go fmt`. - * Squash your commits into a single commit. `git rebase -i`. It's okay to force update your pull request. - * Run `make check` and ensure it succeeds. [Travis CI](https://travis-ci.org/gohugoio/hugo) and [Appveyor](https://ci.appveyor.com/project/gohugoio/hugo) will runs these checks and fail the build if `make check` fails. - -## Contribution Overview - -We wrote a [detailed guide]({{< relref "tutorials/how-to-contribute-to-hugo.md" >}}) for newcomers that guides you step by step to your first contribution. If you are more experienced, follow the guide below. - - -# Building from source - -## Vendored Dependencies - -Hugo uses [govendor][] to vendor dependencies, but we don't commit the vendored packages themselves to the Hugo git repository. -Therefore, a simple `go get` is not supported since `go get` is not vendor-aware. -You **must use govendor** to fetch Hugo's dependencies. - -## Fetch the Sources - - go get github.com/kardianos/govendor - govendor get github.com/gohugoio/hugo - -## Running Hugo - - cd $HOME/go/src/github.com/gohugoio/hugo - go run main.go - -## Building Hugo - - cd $HOME/go/src/github.com/gohugoio/hugo - make build - # or to install to $HOME/go/bin: - make install - - -# Showcase additions - -You got your new website running and it's powered by Hugo? Great. You can add your website with a few steps to the [showcase](/showcase/). - -First, make sure that you created a [fork](https://help.github.com/articles/fork-a-repo/) of the [`hugoDocs`](https://github.com/gohugoio/hugodocs) repository on GitHub and cloned your fork on your local computer. **Next, create a separate branch for your additions**: - -``` -# You can choose a different descriptive branch name if you like -git checkout -b showcase-addition -``` - -Let's create a new document that contains some metadata of your homepage. Replace `example` in the following examples with something unique like the name of your website. Inside the terminal enter the following commands: - -``` -cd docs -hugo new showcase/example.md -``` - -You should find the new file at `content/showcase/example.md`. Open it in an editor. The file should contain a frontmatter with predefined variables like below: - -``` ---- -date: 2016-02-12T21:01:18+01:00 -description: "" -license: "" -licenseLink: "" -sitelink: http://spf13.com/ -sourceLink: https://github.com/spf13/spf13.com -tags: -- personal -- blog -thumbnail: /img/spf13-tn.jpg -title: example ---- -``` - -Add at least values for `sitelink`, `title`, `description` and a path for `thumbnail`. - -Furthermore, we need to create the thumbnail of your website. **It's important that the thumbnail has the required dimensions of 600px by 400px.** Give your thumbnail a name like `example-tn.png`. Save it under `static/img/`. - -Check a last time that everything works as expected. Start Hugo's built-in server in order to inspect your local copy of the showcase in the browser: - - hugo server - -If everything looks fine, we are ready to commit your additions. For the sake of best practices, please make sure that your commit follows our [code contribution guideline](https://github.com/gohugoio/hugo#code-contribution-guideline). - - git commit -m"Add example.com to the showcase" - -Last but not least, we're ready to create a [pull request](https://github.com/gohugoio/hugoDocs/compare). - -Don't forget to accept the contributor license agreement. Click on the yellow badge in the automatically added comment in the pull request. - -[govendor]: https://github.com/kardianos/govendor diff --git a/content/content/example.md b/content/content/example.md deleted file mode 100644 index 022764994..000000000 --- a/content/content/example.md +++ /dev/null @@ -1,91 +0,0 @@ ---- -aliases: -- /doc/example/ -lastmod: 2015-12-23 -date: 2013-07-01 -linktitle: Example -menu: - main: - parent: content -prev: /content/multilingual -next: /content/using-index-md -notoc: true -title: Example Content File -weight: 70 ---- - -Some things are better shown than explained. The following is a very basic example of a content file written in [Markdown](https://help.github.com/articles/github-flavored-markdown/): - -**mysite/content/project/nitro.md → http://mysite.com/project/nitro.html** - -With TOML front matter: - -
+++
-date        = "2013-06-21T11:27:27-04:00"
-title       = "Nitro: A quick and simple profiler for Go"
-description = "Nitro is a simple profiler for your Golang applications"
-tags        = [ "Development", "Go", "profiling" ]
-topics      = [ "Development", "Go" ]
-slug        = "nitro"
-project_url = "https://github.com/spf13/nitro"
-+++
-# Nitro
-
-Quick and easy performance analyzer library for [Go](http://golang.org/).
-
-## Overview
-
-Nitro is a quick and easy performance analyzer library for Go.
-It is useful for comparing A/B against different drafts of functions
-or different functions.
-
-## Implementing Nitro
-
-Using Nitro is simple. First, use `go get` to install the latest version
-of the library.
-
-    $ go get github.com/spf13/nitro
-
-Next, include nitro in your application.
-
- -You may also use the equivalent YAML front matter: - -```yaml ---- -lastmod: 2015-12-23 -date: "2013-06-21T11:27:27-04:00" -title: "Nitro: A quick and simple profiler for Go" -description: "Nitro is a simple profiler for your Go lang applications" -tags: [ "Development", "Go", "profiling" ] -topics: [ "Development", "Go" ] -slug: "nitro" -project_url: "https://github.com/spf13/nitro" ---- -``` - -`nitro.md` would be rendered as follows: - -> # Nitro -> -> Quick and easy performance analyzer library for [Go](http://golang.org/). -> -> ## Overview -> -> Nitro is a quick and easy performance analyzer library for Go. -> It is useful for comparing A/B against different drafts of functions -> or different functions. -> -> ## Implementing Nitro -> -> Using Nitro is simple. First, use `go get` to install the latest version -> of the library. -> -> $ go get github.com/spf13/nitro -> -> Next, include nitro in your application. - -The source `nitro.md` file is converted to HTML by the excellent -[Blackfriday](https://github.com/russross/blackfriday) Markdown processor, -which supports extended features found in the popular -[GitHub Flavored Markdown](https://help.github.com/articles/github-flavored-markdown/). diff --git a/content/content/markdown-extras.md b/content/content/markdown-extras.md deleted file mode 100644 index 7673c53da..000000000 --- a/content/content/markdown-extras.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -aliases: -- /doc/supported-formats/ -lastmod: 2016-07-22 -date: 2016-07-22 -menu: - main: - parent: content -prev: /content/summaries -next: /content/multilingual -title: Markdown Extras -weight: 66 -toc: false ---- - -Hugo provides some convenient markdown extensions. - -## Task lists - -Hugo supports GitHub styled task lists (TODO lists) for the Blackfriday renderer (md-files). See [Blackfriday config](/overview/configuration/#configure-blackfriday-rendering) for how to turn it off. - -Example: - -```markdown -- [ ] a task list item -- [ ] list syntax required -- [ ] incomplete -- [x] completed -``` - -Renders as: - -- [ ] a task list item -- [ ] list syntax required -- [ ] incomplete -- [x] completed - - -And produces this HTML: - -```html - - -``` diff --git a/content/content/multilingual.md b/content/content/multilingual.md deleted file mode 100644 index 5e09bc539..000000000 --- a/content/content/multilingual.md +++ /dev/null @@ -1,232 +0,0 @@ ---- -date: 2016-01-02T21:21:00Z -menu: - main: - parent: content -prev: /content/markdown-extras -next: /content/example -title: Multilingual Mode -weight: 68 -toc: true ---- -Hugo supports multiple languages side-by-side (added in `Hugo 0.17`). Define the available languages in a `Languages` section in your top-level `config.toml` (or equivalent). - -Example: - -``` -DefaultContentLanguage = "en" -copyright = "Everything is mine" - -[params.navigation] -help = "Help" - -[Languages] -[Languages.en] -title = "My blog" -weight = 1 -[Languages.en.params] -linkedin = "english-link" - -[Languages.fr] -copyright = "Tout est à moi" -title = "Mon blog" -weight = 2 -[Languages.fr.params] -linkedin = "lien-francais" -[Languages.fr.navigation] -help = "Aide" - -``` - -Anything not defined in a `[Languages]` block will fall back to the global -value for that key (like `copyright` for the English (`en`) language in this example). - -With the config above, all content, sitemap, RSS feeds, paginations -and taxonomy pages will be rendered below `/` in English (your default content language), and below `/fr` in French. - -When working with params in frontmatter pages, omit the `params` in the key for the translation. - -If you want all of the languages to be put below their respective language code, enable `defaultContentLanguageInSubdir: true` in your configuration. - -Only the obvious non-global options can be overridden per language. Examples of global options are `BaseURL`, `BuildDrafts`, etc. - -Taxonomies and Blackfriday configuration can also be set per language, example: - -``` -[Taxonomies] -tag = "tags" - -[blackfriday] -angledQuotes = true -hrefTargetBlank = true - -[Languages] -[Languages.en] -weight = 1 -title = "English" -[Languages.en.blackfriday] -angledQuotes = false - -[Languages.fr] -weight = 2 -title = "Français" -[Languages.fr.Taxonomies] -plaque = "plaques" -``` - - -### Translating your content - -Translated articles are identified by the name of the content file. - -Example of translated articles: - -1. `/content/about.en.md` -2. `/content/about.fr.md` - -You can also have: - -1. `/content/about.md` -2. `/content/about.fr.md` - -In which case the config variable `defaultContentLanguage` will be used to affect the default language `about.md`. This way, you can -slowly start to translate your current content without having to rename everything. - -If left unspecified, the value for `defaultContentLanguage` defaults to `en`. - -By having the same _base file name_, the content pieces are linked together as translated pieces. - -If you need distinct URLs per language you can set the slug in the non-default language file. Just define the custom slug for the french translation in your `/content/about.fr.md` file: - -``` ---- -slug: "a-propos" ---- -``` - -You will get both `/about/` and `/a-propos/` URLs in your build, properly linked as translated pieces. - -### Link to translated content - -To create a list of links to translated content, use a template similar to this: - -``` -{{ if .IsTranslated }} -

{{ i18n "translations" }}

- -{{ end }} -``` -The above can be put in a `partial` and included in any template, be it for a content page or the home page. It will not print anything if there are no translations for a given page, or if it is -- in the case of the home page, section listing etc. -- a site with only one language. - -The above also uses the `i18n` func, see [Translation of strings](#translation-of-strings). - -### Translation of strings - -Hugo uses [go-i18n](https://github.com/nicksnyder/go-i18n) to support string translations. Follow the link to find tools to manage your translation workflows. - -Translations are collected from the `themes/[name]/i18n/` folder (built into the theme), as well as translations present in `i18n/` at the root of your project. In the `i18n`, the translations will be merged and take precedence over what is in the theme folder. Language files should be named according to RFC 5646 with names such as `en-US.toml`, `fr.toml`, etc. - -From within your templates, use the `i18n` function like this: - -``` -{{ i18n "home" }} -``` - -This uses a definition like this one in `i18n/en-US.toml`: - -``` -[home] -other = "Home" -``` - -Often you will want to use to the page variables in the translations strings. To do that, pass on the "." context when calling `i18n`: - -``` -{{ i18n "wordCount" . }} -``` - -This uses a definition like this one in `i18n/en-US.toml`: - -``` -[wordCount] -other = "This article has {{ .WordCount }} words." -``` -An example of singular and plural form: - -``` -[readingTime] -one = "One minute read" -other = "{{.Count}} minutes read" -``` -And then in the template: - -``` -{{ i18n "readingTime" .ReadingTime }} -``` -To track down missing translation strings, run Hugo with the `--i18n-warnings` flag: - -```bash - hugo --i18n-warnings | grep i18n -i18n|MISSING_TRANSLATION|en|wordCount -``` - -### Menus - -You can define your menus for each language independently. The [creation of a menu]({{< relref "extras/menus.md" >}}) works analogous to earlier versions of Hugo, except that they have to be defined in their language-specific block in the configuration file: - -```toml -defaultContentLanguage = "en" - -[languages.en] -weight = 0 -languageName = "English" - -[[languages.en.menu.main]] -url = "/" -name = "Home" -weight = 0 - - -[languages.de] -weight = 10 -languageName = "Deutsch" - -[[languages.de.menu.main]] -url = "/" -name = "Startseite" -weight = 0 -``` - -The rendering of the main navigation works as usual. `.Site.Menus` will just contain the menu of the current language. Pay attention to the generation of the menu links. `absLangURL` takes care that you link to the correct locale of your website. Otherwise, both menu entries would link to the English version because it's the default content language that resides in the root directory. - -```html - - -``` - -### Missing translations - -If a string does not have a translation for the current language, Hugo will use the value from the default language. If no default value is set, an empty string will be shown. - -While translating a Hugo site, it can be handy to have a visual indicator of missing translations. The `EnableMissingTranslationPlaceholders` config option will flag all untranslated strings with the placeholder `[i18n] identifier`, where `identifier` is the id of the missing translation. - -**Remember: Hugo will generate your website with these placeholders. It might not be suited for production environments.** - -### Multilingual Themes support - -To support Multilingual mode in your themes, some considerations must be taken for the URLs in the templates. If there are more than one language, URLs must either come from the built-in `.Permalink` or `.URL`, be constructed with `relLangURL` or `absLangURL` template funcs -- or prefixed with `{{.LanguagePrefix }}`. - -If there are more than one language defined, the`LanguagePrefix` variable will equal `"/en"` (or whatever your `CurrentLanguage` is). If not enabled, it will be an empty string, so it is harmless for single-language sites. diff --git a/content/content/supported-formats.md b/content/content/supported-formats.md deleted file mode 100644 index 3fc905d6d..000000000 --- a/content/content/supported-formats.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -aliases: -- /doc/supported-formats/ -lastmod: 2015-08-01 -date: 2015-08-01 -menu: - main: - parent: content -next: /content/front-matter -prev: /content/organization -title: Supported Formats -weight: 15 -toc: true ---- - - Since 0.14, Hugo has defined a new concept called _external helpers_. It means that you can write your content using Asciidoc[tor], reStructuredText or Org-Mode. If you have files with associated extensions ([details](https://github.com/gohugoio/hugo/blob/77c60a3440806067109347d04eb5368b65ea0fe8/helpers/general.go#L65)), then Hugo will call external commands to generate the content (the exception being Org-Mode content, which is parsed natively). - - This means that you will have to install the associated tool on your machine to be able to use those formats. - - For example, for Asciidoc files, Hugo will try to call __asciidoctor__ or __asciidoc__ command. - - To use those formats, just use the standard extension and the front matter exactly as you would do with natively supported _.md_ files. - - Notes: - - * as these are external commands, generation performance for that content will heavily depend on the performance of those external tools. - * this feature is still in early stage, hence feedback is even more welcome. diff --git a/content/content/using-index-md.md b/content/content/using-index-md.md deleted file mode 100644 index 1f1298f67..000000000 --- a/content/content/using-index-md.md +++ /dev/null @@ -1,118 +0,0 @@ ---- -aliases: -- /doc/using-index-md/ -lastmod: 2017-02-22 -date: 2017-02-22 -linktitle: Using _index.md -menu: - main: - parent: content -prev: /content/example -next: /themes/overview -notoc: true -title: Using _index.md -weight: 70 ---- -# \_index.md and 'Everything is a Page' - -As of version v0.18 Hugo now treats '[everything as a page](http://bepsays.com/en/2016/12/19/hugo-018/)'. This allows you to add content and frontmatter to any page - including List pages like [Sections](/content/sections/), [Taxonomies](/taxonomies/overview/), [Taxonomy Terms pages](/templates/terms/) and even to potential 'special case' pages like the [Home page](/templates/homepage/). - -In order to take advantage of this behaviour you need to do a few things. - -1. Create an \_index.md file that contains the frontmatter and content you would like to apply. - -2. Place the \_index.md file in the correct place in the directory structure. - -3. Ensure that the respective template is configured to display `{{ .Content }}` if you wish for the content of the \_index.md file to be rendered on the respective page. - -## How \_index.md pages work - -Before continuing it's important to know that this page must reference certain templates to describe how the \_index.md page will be rendered. Hugo has a multitude of possible templates that can be used and placed in various places (think theme templates for instance). For simplicity/brevity the default/top level template location will be used to refer to the entire range of places the template can be placed. - -If this is confusing or you are unfamiliar with Hugo's template hierarchy, visit the various template pages listed below. You may need to find the 'active' template responsible for any particular page on your own site by going through the template hierarchy and matching it to your particular setup/theme you are using. - -- [Home page template](/templates/homepage/) -- [Content List templates](/templates/list/) -- [Single Content templates](/templates/content/) -- [Taxonomy Terms templates](/templates/terms/) - -Now that you've got a handle on templates lets recap some Hugo basics to understand how to use an \_index.md file with a List page. - -1. Sections and Taxonomies are 'List' pages, NOT single pages. -2. List pages are rendered using the template hierarchy found in the [Content - List Template](/templates/list/) docs. -3. The Home page, though technically a List page, can have [its own template](/templates/homepage/) at layouts/index.html rather than \_default/list.html. Many themes exploit this behaviour so you are likely to encounter this specific use case. -4. Taxonomy terms pages are 'lists of metadata' not lists of content, so [have their own templates](/templates/terms/). - -Let's put all this information together: - -> **\_index.md files used in List pages, Terms pages or the Home page are NOT rendered as single pages or with Single Content templates.** - -> **All pages, including List pages, can have frontmatter and frontmatter can have markdown content - meaning \_index.md files are the way to _provide_ frontmatter and content to the respective List/Terms/Home page.** - -Here are a couple of examples to make it clearer... - -| \_index.md location | Page affected | Rendered by | -| ------------------- | ------------ | ----------- | -| /content/post/\_index.md | site.com/post/ | /layouts/section/post.html | -| /content/categories/hugo/\_index.md | site.com/categories/hugo/ | /layouts/taxonomy/hugo.html | - -## Why \_index.md files are used - -With a Single page such as a post it's possible to add the frontmatter and content directly into the .md page itself. With List/Terms/Home pages this is not possible so \_index.md files can be used to provide that frontmatter/content to them. - -## How to display content from \_index.md files - -From the information above it should follow that content within an \_index.md file won't be rendered in its own Single Page, instead it'll be made available to the respective List/Terms/Home page. - -To **_actually render that content_** you need to ensure that the relevant template responsible for rendering the List/Terms/Home page contains (at least) `{{ .Content }}`. - -This is the way to actually display the content within the \_index.md file on the List/Terms/Home page. - -A very simple/naive example of this would be: - -```html -{{ partial "header.html" . }} -
- {{ .Content }} - {{ range .Paginator.Pages }} - {{ partial "summary.html" . }} - {{ end }} - {{ partial "pagination.html" . }} -
-{{ partial "sidebar.html" . }} -{{ partial "footer.html" . }} -``` - -You can see `{{ .Content }}` just after the `
` element. For this particular example, the content of the \_index.md file will show before the main list of summaries. - -## Where to organise an \_index.md file - -To add content and frontmatter to the home page, a section, a taxonomy or a taxonomy terms listing, add a markdown file with the base name \_index on the relevant place on the file system. - -```bash -└── content - ├── _index.md - ├── categories - │   ├── _index.md - │   └── photo - │   └── _index.md - ├── post - │   ├── _index.md - │   └── firstpost.md - └── tags - ├── _index.md - └── hugo - └── _index.md -``` - -In the above example \_index.md pages have been added to each section/taxonomy. - -An \_index.md file has also been added in the top level 'content' directory. - -### Where to place \_index.md for the Home page - -Hugo themes are designed to use the 'content' directory as the root of the website, so adding an \_index.md file here (like has been done in the example above) is how you would add frontmatter/content to the home page. - - - - diff --git a/content/extras/aliases.md b/content/extras/aliases.md deleted file mode 100644 index 00f014ca0..000000000 --- a/content/extras/aliases.md +++ /dev/null @@ -1,103 +0,0 @@ ---- -aliases: -- /doc/redirects/ -- /doc/alias/ -- /doc/aliases/ -lastmod: 2015-12-23 -date: 2013-07-09 -menu: - main: - parent: extras -next: /extras/analytics -prev: /taxonomies/methods -title: Aliases ---- - -For people migrating existing published content to Hugo, there's a good chance you need a mechanism to handle redirecting old URLs. - -Luckily, redirects can be handled easily with _aliases_ in Hugo. - -## Example - -Given a post on your current Hugo site, with a path of: - -``content/posts/my-awesome-blog-post.md`` - -... you create an "aliases" section in the frontmatter of your post, and add previous paths to that. - -### TOML frontmatter - -```toml -+++ - ... -aliases = [ - "/posts/my-original-url/", - "/2010/01/01/even-earlier-url.html" -] - ... -+++ -``` - -### YAML frontmatter - -```yaml ---- - ... -aliases: - - /posts/my-original-url/ - - /2010/01/01/even-earlier-url.html - ... ---- -``` - -Now when you visit any of the locations specified in aliases, _assuming the same site domain_, you'll be redirected to the page they are specified on. - -## Important Behaviors - -1. *Hugo makes no assumptions about aliases. They also don't change based -on your UglyURLs setting. You need to provide absolute path to your webroot -and the complete filename or directory.* - -2. *Aliases are rendered prior to any content and will be overwritten by -any content with the same location.* - -## Multilingual example - -On [multilingual sites]({{< relref "content/multilingual.md" >}}), each translation of a post can have unique aliases. To use the same alias across multiple languages, prefix it with the language code. - -In `/posts/my-new-post.es.md`: - -```yaml ---- -aliases: - - /es/posts/my-original-post/ ---- -``` - -## How Hugo Aliases Work - -When aliases are specified, Hugo creates a physical folder structure to match the alias entry, and, an html file specifying the canonical URL for the page, and a redirect target. - -Assuming a baseURL of `mysite.tld`, the contents of the html file will look something like: - -```html - - - - http://mysite.tld/posts/my-original-url - - - - - -``` - -The `http-equiv="refresh"` line is what performs the redirect, in 0 seconds in this case. - -## Customizing - -You may customize this alias page by creating an alias.html template in the -layouts folder of your site. In this case, the data passed to the template is - -* Permalink - the link to the page being aliased -* Page - the Page data for the page being aliased diff --git a/content/extras/analytics.md b/content/extras/analytics.md deleted file mode 100644 index 31f44c7bf..000000000 --- a/content/extras/analytics.md +++ /dev/null @@ -1,28 +0,0 @@ ---- -date: 2016-02-06 -linktitle: Analytics -menu: - main: - parent: extras -next: /extras/builders -prev: /extras/aliases -title: Analytics in Hugo ---- - -Hugo ships with prebuilt internal templates for Google Analytics tracking, including both synchronous and asynchronous tracking codes. - -## Configuring Google Analytics - -Provide your tracking id in your configuration file, e.g. config.yaml. - - googleAnalytics = "UA-123-45" - -## Example - -Include the internal template in your templates like so: - - {{ template "_internal/google_analytics.html" . }} - -For async include the async template: - - {{ template "_internal/google_analytics_async.html" . }} diff --git a/content/extras/builders.md b/content/extras/builders.md deleted file mode 100644 index 707eff306..000000000 --- a/content/extras/builders.md +++ /dev/null @@ -1,56 +0,0 @@ ---- -lastmod: 2015-12-24 -date: 2014-05-26 -linktitle: Builders -menu: - main: - parent: extras -next: /extras/comments -prev: /extras/analytics -title: Hugo Builders ---- - -Hugo provides the functionality to quickly get a site, theme or page -started. - - -## New Site - -Want to get a site built quickly? - -{{< nohighlight >}}$ hugo new site path/to/site -{{< /nohighlight >}} - -Hugo will create all the needed directories and files to get started -quickly. - -Hugo will only touch the files and create the directories (in the right -places), [configuration](/overview/configuration/) and content are up to -you... but luckily we have builders for content (see below). - -## New Theme - -Want to design a new theme? - - $ hugo new theme THEME_NAME - -Run from your working directory, this will create a new theme with all -the needed files in your themes directory. Hugo will provide you with a -license and theme.toml file with most of the work done for you. - -Follow the [Theme Creation Guide](/themes/creation/) once the builder is -done. - -## New Content - -You will use this builder the most of all. Every time you want to create -a new piece of content, the content builder will get you started right. - -Leveraging [content archetypes](/content/archetypes/) the content builder -will not only insert the current date and appropriate metadata, but it -will pre-populate values based on the content type. - - $ hugo new relative/path/to/content - -This assumes it is being run from your working directory and the content -path starts from your content directory. Now, Hugo watches your content directory by default and rebuilds your entire website if any change occurs. diff --git a/content/extras/datafiles.md b/content/extras/datafiles.md deleted file mode 100644 index dc7e8059c..000000000 --- a/content/extras/datafiles.md +++ /dev/null @@ -1,106 +0,0 @@ ---- -aliases: -- /doc/datafiles/ -lastmod: 2015-08-04 -date: 2015-01-22 -menu: - main: - parent: extras -next: /extras/datadrivencontent -prev: /extras/robots-txt -title: Data Files ---- - -In addition to the [built-in variables](/templates/variables/) available from Hugo, you can specify your own custom data that can be accessed via templates or shortcodes. - -Hugo supports loading data from [YAML](http://yaml.org/), [JSON](http://www.json.org/), and [TOML](https://github.com/toml-lang/toml) files located in the `data` directory. - -**It even works with [LiveReload](/extras/livereload/).** - -Data Files can also be used in [themes](/themes/overview/), but note: If the same `key` is used in both the main data folder and in the theme's data folder, the main one will win. So, for theme authors, for theme specific data items that shouldn't be overridden, it can be wise to prefix the folder structure with a namespace, e.g. `mytheme/data/mytheme/somekey/...`. To check if any such duplicate exists, run hugo with the `-v` flag, e.g. `hugo -v`. - -## The Data Folder - -The `data` folder is where you can store additional data for Hugo to use when generating your site. Data files aren't used to generate standalone pages - rather they're meant to supplement the content files. This feature can extend the content in case your frontmatter would grow immensely. Or perhaps you want to show a larger dataset in a template (see example below). In both cases it's a good idea to outsource the data in their own file. - -These files must be YAML, JSON or TOML files (using either the `.yml`, `.yaml`, `.json` or `toml` extension) and the data will be accessible as a `map` in `.Site.Data`. - -**The keys in this map will be a dot chained set of _path_, _filename_ and _key_ in file (if applicable).** - -This is best explained with an example: - -## Example: Jaco Pastorius' Solo Discography - -[Jaco Pastorius](http://en.wikipedia.org/wiki/Jaco_Pastorius_discography) was a great bass player, but his solo discography is short enough to use as an example. [John Patitucci](http://en.wikipedia.org/wiki/John_Patitucci) is another bass giant. - -The example below is a bit constructed, but it illustrates the flexibility of Data Files. It uses TOML as file format. - -Given the files: - -* `data/jazz/bass/jacopastorius.toml` -* `data/jazz/bass/johnpatitucci.toml` - -`jacopastorius.toml` contains the content below, `johnpatitucci.toml` contains a similar list: - -``` -discography = [ -"1974 – Modern American Music … Period! The Criteria Sessions", -"1974 – Jaco", -"1976 - Jaco Pastorius", -"1981 - Word of Mouth", -"1981 - The Birthday Concert (released in 1995)", -"1982 - Twins I & II (released in 1999)", -"1983 - Invitation", -"1986 - Broadway Blues (released in 1998)", -"1986 - Honestly Solo Live (released in 1990)", -"1986 - Live In Italy (released in 1991)", -"1986 - Heavy'n Jazz (released in 1992)", -"1991 - Live In New York City, Volumes 1-7.", -"1999 - Rare Collection (compilation)", -"2003 - Punk Jazz: The Jaco Pastorius Anthology (compilation)", -"2007 - The Essential Jaco Pastorius (compilation)" -] -``` - -The list of bass players can be accessed via `.Site.Data.jazz.bass`, a single bass player by adding the filename without the suffix, e.g. `.Site.Data.jazz.bass.jacopastorius`. - -You can now render the list of recordings for all the bass players in a template: - -``` -{{ range $.Site.Data.jazz.bass }} - {{ partial "artist.html" . }} -{{ end }} -``` - -And then in `partial/artist.html`: - -``` - -``` - -Discover a new favourite bass player? Just add another TOML-file. - -## Example: Accessing named values in a Data File - -Assuming you have the following YAML structure to your `User0123.yml` Data File located directly in `data/` - -``` -Name: User0123 -"Short Description": "He is a **jolly good** fellow." -Achievements: - - "Can create a Key, Value list from Data File" - - "Learns Hugo" - - "Reads documentation" -``` - -To render the `Short Description` in your `layout` File following code is required. - -``` -
Short Description of {{.Site.Data.User0123.Name}}:

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

-``` - -Note the use of the `markdownify` template function. This will send the description through the Blackfriday Markdown rendering engine. diff --git a/content/extras/gitinfo.md b/content/extras/gitinfo.md deleted file mode 100644 index d267e0e3f..000000000 --- a/content/extras/gitinfo.md +++ /dev/null @@ -1,54 +0,0 @@ ---- -aliases: -- /doc/gitinfo/ -lastmod: 2016-12-11 -date: 2016-12-11 -menu: - main: - parent: extras -next: /extras/livereload -prev: /extras/datadrivencontent -title: GitInfo ---- - -Hugo provides a way to integrate Git data into your site. - - -## Prerequisites - -1. The Hugo site must be in a Git-enabled directory. -1. The Git executable must be installed and in your system `PATH`. -1. Enable the GitInfo feature in Hugo by using `--enableGitInfo` on the command - line or by setting `enableGitInfo` to `true` in your site configuration. - -## The GitInfo Object - -The `GitInfo` object contains the following fields: - -AbbreviatedHash -: abbreviated commit hash, e.g. `866cbcc` - -AuthorName -: author name, respecting `.mailmap` - -AuthorEmail -: author email address, respecting `.mailmap` - -AuthorDate -: the author date - -Hash -: commit hash, e.g. `866cbccdab588b9908887ffd3b4f2667e94090c3` - -Subject -: commit message subject, e.g. `tpl: Add custom index function` - - -## Other Considerations - -The Git integrations should be fairly performant, but it does add some time to the build, which depends somewhat on the Git history size. - -The accuracy of data depends on the underlying local git respository. If the local repository is a *shallow clone*, then any file that hasn't been modified in the truncated history will default to data in the oldest commit. In particular, if the respository has been cloned using `--depth=1` then every file will the exact same `GitInfo` data -- that of the only commit in the repository. - -In particular, many CI/CD systems such as [travis-ci.org](https://travis-ci.org) default to a clone depth of 50 which is unlikely to be deep enough. You can explicitly add back the missing history using using `git fetch --unshallow` or [make the initial checkout deeper](https://docs.travis-ci.com/user/customizing-the-build#Git-Clone-Depth). - diff --git a/content/extras/livereload.md b/content/extras/livereload.md deleted file mode 100644 index cb4047636..000000000 --- a/content/extras/livereload.md +++ /dev/null @@ -1,74 +0,0 @@ ---- -lastmod: 2016-08-09 -date: 2014-05-26 -menu: - main: - parent: extras -next: /extras/menus -prev: /extras/gitinfo -title: LiveReload ---- - -Hugo may not be the first static site generator to utilize LiveReload -technology, but it’s the first to do it right. - -The combination of Hugo’s insane build speed and LiveReload make -crafting your content pure joy. Virtually instantly after you hit save -your rebuilt content will appear in your browser. - -## Using LiveReload - -Hugo comes with LiveReload built in. There are no additional packages to -install. A common way to use Hugo while developing a site is to have -Hugo run a server and watch for changes: - -{{< nohighlight >}}$ hugo server -{{< /nohighlight >}} - -This will run a full functioning web server while simultaneously -watching your file system for additions, deletions or changes within -your: - - * static files - * content - * data files - * layouts - * current theme - * configuration files - -Whenever anything changes, Hugo will rebuild the site while continuing to serve -the content. As soon as the build is finished, it will tell the -browser and silently reload the page. Because most Hugo builds are so -fast they are barely noticeable, you merely need to glance at your open -browser and you will see the change, already there. - -This means that keeping the site open on a second monitor (or another -half of your current monitor) allows you to see exactly what your -content looks like, without even leaving your text editor. - -## Disabling Watch - -If for some reason you don't want the Hugo server's watch functionality, -just do: - -{{< nohighlight >}}$ hugo server --watch=false -{{< /nohighlight >}} - -## Disabling LiveReload - -LiveReload works by injecting JavaScript into the pages Hugo generates, -which creates a connection from the browser web socket client to the -Hugo web socket server. - -Awesome for development, but not something you would want to do in -production. Since many people use `hugo server` in production to -instantly display any updated content, we’ve made it easy to disable the -LiveReload functionality: - -{{< nohighlight >}}$ hugo server --disableLiveReload -{{< /nohighlight >}} - -## Notes - -You must have a closing `` tag for LiveReload to work. -Hugo injects the LiveReload ` - - {{ "" | safeHTML }} - {{ `` | safeHTML }} - - - - - {{ "" | safeHTML }} - - -{{ "" | safeHTML }} -{{ template "partials/analytics.html" . }} - - diff --git a/layouts/index.redir b/layouts/index.redir deleted file mode 100644 index 2dfd2bc0f..000000000 --- a/layouts/index.redir +++ /dev/null @@ -1,6 +0,0 @@ -# Netlify redirects. See https://www.netlify.com/docs/redirects/ -{{ range $p := .Site.Pages -}} -{{ range .Aliases }} -{{ . | printf "%-35s" }} {{ $p.RelPermalink -}} -{{ end -}} -{{- end -}} diff --git a/layouts/partials/analytics.html b/layouts/partials/analytics.html deleted file mode 100644 index a30754c0a..000000000 --- a/layouts/partials/analytics.html +++ /dev/null @@ -1,10 +0,0 @@ - diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html deleted file mode 100644 index 6f9976448..000000000 --- a/layouts/partials/footer.html +++ /dev/null @@ -1,59 +0,0 @@ -
-
-

Last revision: {{ .Lastmod.Format "January 2, 2006" }}{{ if .IsPage }}{{ with .GitInfo }} | {{ .Subject }} ({{ .AbbreviatedHash }}){{end }}{{ end }} - Hugo v{{ .Site.Params.release }} documentation -

- {{ with getenv "REPOSITORY_URL" -}} - - - - {{- end }} -
-
- - - - - - -
- {{ if .IsPage }} - {{ with .GetParam "next" }} - - {{ end }} - {{ end }} -
- - - - - - - - - - - - - - - - - - - - - {{ template "partials/analytics.html" . }} - - diff --git a/layouts/partials/header.html b/layouts/partials/header.html deleted file mode 100644 index 8149a7bb6..000000000 --- a/layouts/partials/header.html +++ /dev/null @@ -1,93 +0,0 @@ - - - - - - - {{ with .Site.Params.author }}{{ end }} - {{ .Hugo.Generator }} - -{{ .Scratch.Add "title" "" }}{{ if isset .Site.Data.titles .Title }}{{ .Scratch.Set "title" (index .Site.Data.titles .Title).title }}{{ else }}{{ .Scratch.Set "title" .Title}}{{end}} - Hugo - {{ .Scratch.Get "title" }} - - - - - - - - - - - - - - - - -
- - -
-
- -
-
- - - - -
- - -
- - -
- - -{{ partial "menu.html" . }} - - -
-
- - - - - - - - - - - - - -
-
- {{ if .IsPage }} - {{ with .GetParam "prev" }} - - {{ end }} - {{ end }} -
-
-
- - - -
-
-
- {{ partial "search.html" . }} -
-
diff --git a/layouts/partials/menu.html b/layouts/partials/menu.html deleted file mode 100644 index d9667291d..000000000 --- a/layouts/partials/menu.html +++ /dev/null @@ -1,40 +0,0 @@ - - - diff --git a/layouts/partials/quotes.html b/layouts/partials/quotes.html deleted file mode 100644 index 3ba0db953..000000000 --- a/layouts/partials/quotes.html +++ /dev/null @@ -1,12 +0,0 @@ -{{ range . }} -
-
-

- {{ .quote | safeHTML }} -

- — {{ .name }} ({{ .twitter_handle }}) - {{ dateFormat "January 2, 2006" .date }} - -
-
-{{ end }} diff --git a/layouts/partials/search.html b/layouts/partials/search.html deleted file mode 100644 index 6a58160cc..000000000 --- a/layouts/partials/search.html +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/layouts/section/commands.html b/layouts/section/commands.html deleted file mode 100644 index afa045452..000000000 --- a/layouts/section/commands.html +++ /dev/null @@ -1,12 +0,0 @@ -{{ partial "header.html" . }} -

Hugo Commands

-

Hugo’s CLI (command line interface) commands are listed here. -This autogenerated list is always up to date (thanks to - Cobra). -

- -{{ partial "footer.html" . }} diff --git a/layouts/section/release-notes.html b/layouts/section/release-notes.html deleted file mode 100644 index 6af512603..000000000 --- a/layouts/section/release-notes.html +++ /dev/null @@ -1,6 +0,0 @@ -{{ define "main" }} -{{ range .Pages }} -

{{ .Title }} {{ .Date.Format "Jan 2, 2006" }}

-{{ .Content }} -{{ end }} -{{ end }} \ No newline at end of file diff --git a/layouts/section/showcase.html b/layouts/section/showcase.html deleted file mode 100644 index be13fc612..000000000 --- a/layouts/section/showcase.html +++ /dev/null @@ -1,17 +0,0 @@ -{{ partial "header.html" . }} - -

Hugo-built Sites (with source)

- -
- {{ range .Data.Pages.ByDate }} - {{ .Render "thumbnail"}} - {{ end }} -
- -
- -
-If you want to be added to this page, please send a pull request. Check out the how-to guide. -
- -{{ partial "footer.html" . }} diff --git a/layouts/shortcodes/datatable-vertical.html b/layouts/shortcodes/datatable-vertical.html deleted file mode 100644 index 1d2629eca..000000000 --- a/layouts/shortcodes/datatable-vertical.html +++ /dev/null @@ -1,26 +0,0 @@ -{{ $package := (index .Params 0) }} -{{ $listname := (index .Params 1) }} -{{ $list := (index (index .Site.Data.docs $package) $listname) }} -{{ $fields := after 2 .Params }} - - {{ range $list }} - {{ range $k, $v := . }} - {{ $.Scratch.Set $k $v }} - {{ end }} - {{ end }} - - {{ range $i, $_ := $fields }} - - {{ $.Scratch.Set "i" $i }} - - {{ $field := (index $fields ($.Scratch.Get "i") ) }} - - {{ range $list }} - - {{ end }} - - - {{ end }} -
{{ $field }} - {{ index . $field }} -
\ No newline at end of file diff --git a/layouts/shortcodes/youtube.html b/layouts/shortcodes/youtube.html deleted file mode 100644 index ce7dd0508..000000000 --- a/layouts/shortcodes/youtube.html +++ /dev/null @@ -1,4 +0,0 @@ -
- -
diff --git a/layouts/showcase/thumbnail.html b/layouts/showcase/thumbnail.html deleted file mode 100644 index 5c36e5d2f..000000000 --- a/layouts/showcase/thumbnail.html +++ /dev/null @@ -1,17 +0,0 @@ -
-
-
-
- {{ .Description }} -

- {{ .Title | safeHTML }} - {{ if (isset .Params "sourcelink") }} - source - {{ end }} -

- {{ range .Params.tags }} - {{ . }} - {{ end }} -
-
-
diff --git a/netlify.toml b/netlify.toml new file mode 100644 index 000000000..f8f124b12 --- /dev/null +++ b/netlify.toml @@ -0,0 +1,5 @@ +[context.next.environment] + HUGO_VERSION = "0.25.1" + HUGO_ENV = "development" + HUGO_BASEURL = "https://next--gohugoio.netlify.com/" + HUGO_ENABLEGITINFO = "true" \ No newline at end of file diff --git a/next-todo.txt b/next-todo.txt new file mode 100644 index 000000000..8925d223d --- /dev/null +++ b/next-todo.txt @@ -0,0 +1,3 @@ +TODO + +* Netlify redirects - OK \ No newline at end of file diff --git a/static/_headers b/static/_headers index 53cc866dc..1216e42d4 100644 --- a/static/_headers +++ b/static/_headers @@ -1,4 +1,5 @@ /* X-Frame-Options: DENY X-XSS-Protection: 1; mode=block - X-Content-Type-Options: nosniff \ No newline at end of file + X-Content-Type-Options: nosniff + Referrer-Policy: origin-when-cross-origin diff --git a/themes/gohugoioTheme b/themes/gohugoioTheme index fcae90950..09edd3733 160000 --- a/themes/gohugoioTheme +++ b/themes/gohugoioTheme @@ -1 +1 @@ -Subproject commit fcae909507f783b722acd2e20aeeb6fadfc43a7a +Subproject commit 09edd373302f24e38f4a18aa61375155f2aa328a