Skip to content

Commit

Permalink
Merge commit 'e81208265bb3cdb7606d051a23d83aeebcb7d34d'
Browse files Browse the repository at this point in the history
  • Loading branch information
bep committed Aug 6, 2017
2 parents 11e5d45 + e812082 commit 22b213b
Show file tree
Hide file tree
Showing 21 changed files with 258 additions and 184 deletions.
2 changes: 2 additions & 0 deletions docs/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ twitter = "GoHugoIO"
removefromexternalsearch = false
## Gh repo for site footer (include trailing slash)
ghrepo = "https://github.com/gohugoio/hugoDocs/"
## GH Repo for filing a new issue
github_repo = "https://github.com/gohugoio/hugo/issues/new"
### Edit content repo (set to automatically enter "edit" mode; this is good for "improve this page" links)
ghdocsrepo = "https://github.com/gohugoio/hugoDocs/tree/master/docs"
## Gitter URL
Expand Down
4 changes: 2 additions & 2 deletions docs/content/content-management/cross-references.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,8 +96,8 @@ More information about document unique identifiers and headings can be found [be

### Examples

* `{{</* ref "blog/post.md" */>}}` => `http://example.com/blog/post/`
* `{{</* ref "post.md#tldr" */>}}` => `http://example.com/blog/post/#tldr:caffebad`
* `{{</* ref "blog/post.md" */>}}` => `https://example.com/blog/post/`
* `{{</* ref "post.md#tldr" */>}}` => `https://example.com/blog/post/#tldr:caffebad`
* `{{</* relref "post.md" */>}}` => `/blog/post/`
* `{{</* relref "blog/post.md#tldr" */>}}` => `/blog/post/#tldr:caffebad`
* `{{</* ref "#tldr" */>}}` => `#tldr:badcaffe`
Expand Down
2 changes: 1 addition & 1 deletion docs/content/content-management/front-matter.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ slug = "spf13-vim-3-0-release-and-new-website"
---
title: "spf13-vim 3.0 release and new website"
description: "spf13-vim is a cross platform distribution of vim plugins and resources for Vim."
#tags: [ ".vimrc", "plugins", "spf13-vim", "vim" ]
tags: [ ".vimrc", "plugins", "spf13-vim", "vim" ]
lastmod: 2015-12-23
date: "2012-04-06"
categories:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/content-management/menus.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ menu:
{{< /code >}}

{{% note %}}
The URLs must be relative to the context root. If the `baseURL` is `http://example.com/mysite/`, then the URLs in the menu must not include the context root `mysite`. Using an absolute URL will overide the baseURL. If the value used for `URL` in the above example is `http://subdomain.example.com/`, the output will be `http://subdomain.example.com`.
The URLs must be relative to the context root. If the `baseURL` is `https://example.com/mysite/`, then the URLs in the menu must not include the context root `mysite`. Using an absolute URL will overide the baseURL. If the value used for `URL` in the above example is `https://subdomain.example.com/`, the output will be `https://subdomain.example.com`.
{{% /note %}}

## Nesting
Expand Down
24 changes: 12 additions & 12 deletions docs/content/content-management/organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,20 @@ While Hugo supports content nested at any level, the top levels (i.e. `content/<
.
└── content
└── about
| └── _index.md // <- http://example.com/about/
| └── _index.md // <- https://example.com/about/
├── post
| ├── firstpost.md // <- http://example.com/post/firstpost/
| ├── firstpost.md // <- https://example.com/post/firstpost/
| ├── happy
| | └── ness.md // <- http://example.com/post/happy/ness/
| └── secondpost.md // <- http://example.com/post/secondpost/
| | └── ness.md // <- https://example.com/post/happy/ness/
| └── secondpost.md // <- https://example.com/post/secondpost/
└── quote
├── first.md // <- http://example.com/quote/first/
└── second.md // <- http://example.com/quote/second/
├── first.md // <- https://example.com/quote/first/
└── second.md // <- https://example.com/quote/second/
```

## Path Breakdown in Hugo

The following demonstrates the relationships between your content organization and the output URL structure for your Hugo website when it renders. These examples assume you are [using pretty URLs][pretty], which is the default behavior for Hugo. The examples also assume a key-value of `baseurl = "http://example.com"` in your [site's configuration file][config].
The following demonstrates the relationships between your content organization and the output URL structure for your Hugo website when it renders. These examples assume you are [using pretty URLs][pretty], which is the default behavior for Hugo. The examples also assume a key-value of `baseurl = "https://example.com"` in your [site's configuration file][config].

### Index Pages: `_index.md`

Expand Down Expand Up @@ -76,7 +76,7 @@ At build, this will output to the following destination with the associated valu
⊢--------^---------⊣⊢-^-⊣
permalink
⊢----------^-------------⊣
http://example.com/posts/index.html
https://example.com/posts/index.html
```

### Single Pages in Sections
Expand All @@ -102,7 +102,7 @@ At the time Hugo builds your site, the content will be output to the following d
⊢--------^--------⊣⊢-^--⊣⊢-------^---------⊣
permalink
⊢--------------------^---------------------⊣
http://example.com/posts/my-first-hugo-post/index.html
https://example.com/posts/my-first-hugo-post/index.html
```

### Section with Nested Directories
Expand All @@ -120,7 +120,7 @@ To continue the example, the following demonstrates destination paths for a file
⊢--------^--------⊣ ⊢------^-----⊣⊢----^------⊣
permalink
⊢----------------------^-----------------------⊣
http://example.com/events/chicago/lollapalooza/
https://example.com/events/chicago/lollapalooza/
```

{{% note %}}
Expand Down Expand Up @@ -201,9 +201,9 @@ layout: mylayout
---
{{< /code >}}
<!-- See https://discourse.gohugo.io/t/path-not-works/6387 -->
<!-- ### `path`
<!-- ### `path`-->

`path` can be provided in the front matter. This will replace the actual path to the file on disk. Destination will create the destination with the same path, including the section. -->
<!--`path` can be provided in the front matter. This will replace the actual path to the file on disk. Destination will create the destination with the same path, including the section. -->

### `url`

Expand Down
4 changes: 2 additions & 2 deletions docs/content/content-management/taxonomies.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ project_url = "https://github.com/gohugoio/hugo"
```
---
title: "Hugo: A fast and flexible static site generator"
#tags: ["Development", "Go", "fast", "Blogging"]
tags: ["Development", "Go", "fast", "Blogging"]
categories: ["Development"]
series: ["Go Web Dev"]
slug: "hugo"
Expand Down Expand Up @@ -216,7 +216,7 @@ categories_weight = 44
```
---
title: foo
#tags: [ "a", "b", "c" ]
tags: [ "a", "b", "c" ]
tags_weight: 22
categories: ["d"]
categories_weight: 44
Expand Down
36 changes: 18 additions & 18 deletions docs/content/content-management/urls.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ permalinks:
post = "/:year/:month/:title/"
{{< /code >}}

Only the content under `post/` will have the new URL structure. For example, the file `content/post/sample-entry.md` with `date: 2017-02-27T19:20:00-05:00` in its front matter will render to `public/2017/02/sample-entry/index.html` at build time and therefore be reachable at `http://example.com/2013/11/sample-entry/`.
Only the content under `post/` will have the new URL structure. For example, the file `content/post/sample-entry.md` with `date: 2017-02-27T19:20:00-05:00` in its front matter will render to `public/2017/02/sample-entry/index.html` at build time and therefore be reachable at `https://example.com/2013/11/sample-entry/`.

### Permalink Configuration Values

Expand Down Expand Up @@ -147,11 +147,11 @@ Assuming a `baseURL` of `example.com`, the contents of the auto-generated alias
<!DOCTYPE html>
<html>
<head>
<title>http://example.com/posts/my-intended-url</title>
<link rel="canonical" href="http://example.com/posts/my-intended-url"/>
<title>https://example.com/posts/my-intended-url</title>
<link rel="canonical" href="https://example.com/posts/my-intended-url"/>
<meta name=\"robots\" content=\"noindex\">
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta http-equiv="refresh" content="0; url=http://example.com/posts/my-intended-url"/>
<meta http-equiv="refresh" content="0; url=https://example.com/posts/my-intended-url"/>
</head>
</html>
```
Expand Down Expand Up @@ -190,7 +190,7 @@ content/posts/post-1.md

## Ugly URLs

If you would like to have are often referred to as "ugly URLs" (e.g., example.com/urls.html), set `uglyurls = true` or `uglyurls: true` in your site's `config.toml` or `config.yaml`, respectively. You can also use the `--uglyURLs=true` [flag from the command line][usage] with `hugo` or `hugo server`..
If you would like to have what are often referred to as "ugly URLs" (e.g., example.com/urls.html), set `uglyurls = true` or `uglyurls: true` in your site's `config.toml` or `config.yaml`, respectively. You can also use the `--uglyURLs=true` [flag from the command line][usage] with `hugo` or `hugo server`..

If you want a specific piece of content to have an exact URL, you can specify this in the [front matter][] under the `url` key. The following are examples of the same content directory and what the eventual URL structure will be when Hugo runs with its default behavior.

Expand All @@ -200,15 +200,15 @@ See [Content Organization][contentorg] for more details on paths.
.
└── content
└── about
| └── _index.md // <- http://example.com/about/
| └── _index.md // <- https://example.com/about/
├── post
| ├── firstpost.md // <- http://example.com/post/firstpost/
| ├── firstpost.md // <- https://example.com/post/firstpost/
| ├── happy
| | └── ness.md // <- http://example.com/post/happy/ness/
| └── secondpost.md // <- http://example.com/post/secondpost/
| | └── ness.md // <- https://example.com/post/happy/ness/
| └── secondpost.md // <- https://example.com/post/secondpost/
└── quote
├── first.md // <- http://example.com/quote/first/
└── second.md // <- http://example.com/quote/second/
├── first.md // <- https://example.com/quote/first/
└── second.md // <- https://example.com/quote/second/
```

Here's the same organization run with `hugo --uglyURLs`:
Expand All @@ -217,23 +217,23 @@ Here's the same organization run with `hugo --uglyURLs`:
.
└── content
└── about
| └── _index.md // <- http://example.com/about/index.html
| └── _index.md // <- https://example.com/about/index.html
├── post
| ├── firstpost.md // <- http://example.com/post/firstpost.html
| ├── firstpost.md // <- https://example.com/post/firstpost.html
| ├── happy
| | └── ness.md // <- http://example.com/post/happy/ness.html
| └── secondpost.md // <- http://example.com/post/secondpost.html
| | └── ness.md // <- https://example.com/post/happy/ness.html
| └── secondpost.md // <- https://example.com/post/secondpost.html
└── quote
├── first.md // <- http://example.com/quote/first.html
└── second.md // <- http://example.com/quote/second.html
├── first.md // <- https://example.com/quote/first.html
└── second.md // <- https://example.com/quote/second.html
```


## Canonicalization

By default, all relative URLs encountered in the input are left unmodified, e.g. `/css/foo.css` would stay as `/css/foo.css`. The `canonifyURLs` field in your site `config` has a default value of `false`.

By setting `canonifyURLs` to `true`, all relative URLs would instead be *canonicalized* using `baseURL`. For example, assuming you have `baseURL = https://example.com/`, the relative URL `/css/foo.css` would be turned into the absolute URL `http://example.com/css/foo.css`.
By setting `canonifyURLs` to `true`, all relative URLs would instead be *canonicalized* using `baseURL`. For example, assuming you have `baseURL = https://example.com/`, the relative URL `/css/foo.css` would be turned into the absolute URL `https://example.com/css/foo.css`.

Benefits of canonicalization include fixing all URLs to be absolute, which may aid with some parsing tasks. Note, however, that all modern browsers handle this on the client without issue.

Expand Down
6 changes: 6 additions & 0 deletions docs/content/contribute/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,12 @@ So, let's clone that master repository:
go get -v -u github.com/gohugoio/hugo
```

Hugo relies on [Testify](https://github.com/stretchr/testify) for testing Go code. If you don't already have it, get the Testify testing tools:

```
go get github.com/stretchr/testify
```

### Fork the repository

If you're not fimiliar with this term, GitHub's [help pages](https://help.github.com/articles/fork-a-repo/) provide again a simple explanation:
Expand Down
2 changes: 1 addition & 1 deletion docs/content/contribute/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ name = ""
license = "MIT"
licenselink = "https://github.com/<YOURNAME>/<YOURTHEME>/blob/master/LICENSE.md"
description = ""
homepage = "http://example.com/"
homepage = "https://example.com/"
tags = []
features = []
min_version = 0.19
Expand Down
4 changes: 2 additions & 2 deletions docs/content/functions/abslangurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ aliases: []

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.

So for a site `baseURL` set to `http://example.com/hugo/` and the current language is `en`:
So for a site `baseURL` set to `https://example.com/hugo/` and the current language is `en`:

```
{{ "blog/" | absLangURL }} → "http://example.com/hugo/en/blog/"
{{ "blog/" | absLangURL }} → "https://example.com/hugo/en/blog/"
{{ "blog/" | relLangURL }} → "/hugo/en/blog/"
```
4 changes: 2 additions & 2 deletions docs/content/functions/absurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ deprecated: false
aliases: []
---

Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `http://example.com/hugo/`:
Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `https://example.com/hugo/`:

```
{{ "mystyle.css" | absURL }} → "http://example.com/hugo/mystyle.css"
{{ "mystyle.css" | absURL }} → "https://example.com/hugo/mystyle.css"
{{ "mystyle.css" | relURL }} → "/hugo/mystyle.css"
{{ "http://gohugo.io/" | relURL }} → "http://gohugo.io/"
{{ "http://gohugo.io/" | absURL }} → "http://gohugo.io/"
Expand Down
2 changes: 1 addition & 1 deletion docs/content/functions/math.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ You can also use the `add` function with strings. You may like this functionalit
For example, social media sharing with [Twitter Cards][cards] requires the following `meta` link in your site's `<head>` to display Twitter's ["Summary Card with Large Image"][twtsummary]:

```
<meta name="twitter:image" content="http://example.com/images/my-twitter-image.jpg">
<meta name="twitter:image" content="https://example.com/images/my-twitter-image.jpg">
```

Let's assume you have an `image` field in the front matter of each of your content files:
Expand Down
4 changes: 2 additions & 2 deletions docs/content/functions/relLangURL.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ aliases: []

`absLangURL` and `relLangURL` functions 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. (See [Configuring Multilingual][multiliconfig].)

So for a site `baseURL` set to `http://example.com/hugo/` and the current language is `en`:
So for a site `baseURL` set to `https://example.com/hugo/` and the current language is `en`:

```
{{ "blog/" | absLangURL }} → "http://example.com/hugo/en/blog/"
{{ "blog/" | absLangURL }} → "https://example.com/hugo/en/blog/"
{{ "blog/" | relLangURL }} → "/hugo/en/blog/"
```

Expand Down
4 changes: 2 additions & 2 deletions docs/content/functions/relurl.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ deprecated: false
aliases: []
---

Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `http://example.com/hugo/`:
Both `absURL` and `relURL` consider the configured value of `baseURL` in your site's [`config` file][configuration]. Given a `baseURL` set to `https://example.com/hugo/`:

```
{{ "mystyle.css" | absURL }} → "http://example.com/hugo/mystyle.css"
{{ "mystyle.css" | absURL }} → "https://example.com/hugo/mystyle.css"
{{ "mystyle.css" | relURL }} → "/hugo/mystyle.css"
{{ "http://gohugo.io/" | relURL }} → "http://gohugo.io/"
{{ "http://gohugo.io/" | absURL }} → "http://gohugo.io/"
Expand Down
8 changes: 8 additions & 0 deletions docs/content/functions/title.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,3 +23,11 @@ aliases: []
```
{{title "BatMan"}}` → "Batman"
```

Can be combined in pipes. In the following snippet, the link text is cleaned up using `humanize` to remove dashes and `title` to convert the value of `$name` to Intial Caps.

```
{{ range $name, $items := .Site.Taxonomies.categories }}
<li><a href="{{ printf "%s/%s" "categories" ($name | urlize | lower) | absURL }}">{{ $name | humanize | title }} ({{ len $items }})</a></li>
{{ end }}
```
2 changes: 1 addition & 1 deletion docs/content/getting-started/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ Your new site already looks great, but you will want to tweak it a little before
Open up `config.toml` in a text editor:

```
baseURL = "http://example.org/"
baseURL = "https://example.org/"
languageCode = "en-us"
title = "My New Hugo Site"
theme = "ananke"
Expand Down
26 changes: 13 additions & 13 deletions docs/content/templates/output-formats.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ A [media type][] (also known as *MIME type* and *content type*) is a two-part id

This is the full set of built-in media types in Hugo:

{{< datatable "media" "types" "Type" "Suffix" >}}
{{< datatable "media" "types" "type" "suffix" >}}

**Note:**

Expand Down Expand Up @@ -55,7 +55,7 @@ Given a media type and some additional configuration, you get an `Output Format`

This is the full set of Hugo's built-in output formats:

{{< datatable "output" "formats" "Name" "MediaType" "Path" "BaseName" "Rel" "Protocol" "IsPlainText" "IsHTML" "NoUgly">}}
{{< datatable "output" "formats" "name" "mediaType" "path" "baseName" "rel" "protocol" "isPlainText" "isHTML" "noUgly">}}

* A page can be output in as many output formats as you want, and you can have an infinite amount of output formats defined **as long as they resolve to a unique path on the file system**. In the above table, the best example of this is `AMP` vs. `HTML`. `AMP` has the value `amp` for `Path` so it doesn't overwrite the `HTML` version; e.g. we can now have both `/index.html` and `/amp/index.html`.
* The `MediaType` must match the `Type` of an already defined media type.
Expand All @@ -71,40 +71,40 @@ isPlainText = true
protocol = "bep://"
```

The above example is fictional, but if used for the homepage on a site with `baseURL` `http://example.org`, it will produce a plain text homepage with the URL `bep://example.org/myindex.enr`.
The above example is fictional, but if used for the homepage on a site with `baseURL` `https://example.org`, it will produce a plain text homepage with the URL `bep://example.org/myindex.enr`.

### Configure Output Formats

The following is the full list of configuration options for output formats and their default values:

`Name`
`name`
: the output format identifier. This is used to define what output format(s) you want for your pages.

`MediaType`
`mediaType`
: this must match the `Type` of a defined media type.

`Path`
`path`
: sub path to save the output files.

`BaseName`
`baseName`
: the base filename for the list filenames (homepage, etc.). **Default:** `index`.

`Rel`
`rel`
: can be used to create `rel` values in `link` tags. **Default:** `alternate`.

`Protocol`
`protocol`
: will replace the "http://" or "https://" in your `baseURL` for this output format.

`IsPlainText`
`isPlainText`
: use Go's plain text templates parser for the templates. **Default:** `false`.

`IsHTML`
`isHTML`
: used in situations only relevant for `HTML`-type formats; e.g., page aliases.

`NoUgly`
`noUgly`
: used to turn off ugly URLs If `uglyURLs` is set to `true` in your site. **Default:** `false`.

`NotAlternative`
`notAlternative`
: enable if it doesn't make sense to include this format in an `AlternativeOutputFormats` format listing on `Page` (e.g., with `CSS`). Note that we use the term *alternative* and not *alternate* here, as it does not necessarily replace the other format. **Default:** `false`.

## Output Formats for Pages
Expand Down
Loading

0 comments on commit 22b213b

Please sign in to comment.