mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
7d7771b673
d3eb97a33 Document .IsSection page variable a068bcf5c Ace and Amber support was removed with #6609 5cd9ca4b2 Mention MacPorts also on the Installing page (#1215) 0ae8f5c19 Add instructions for using Macports d50aba8f0 Revise ref and relref function pages a17e25d6f Update quick-start.md: move notice about drafts up cf87a5da2 Update macOS tarball installation instructions (#1203) 2e701f8f3 Corrected the url for index function link 736bd59e0 Clarify treatment of zero weights (#1207) 42a19f479 Fix example of output from urlize function 34f8de26d Revise content-management/cross-references 252435a95 Rewrite Translation of Strings f0882bc14 Remove note that has been outdated by v0.71.0 dfe28ceb5 Improve mounts module config 58029627d Fix erroneous example code piping to if git-subtree-dir: docs git-subtree-split: d3eb97a3328f5390801bbce017233ce895fc2d28
74 lines
1.9 KiB
Markdown
74 lines
1.9 KiB
Markdown
---
|
|
title: urlize
|
|
# linktitle: urlize
|
|
description: Takes a string, sanitizes it for usage in URLs, and converts spaces to hyphens.
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
categories: [functions]
|
|
menu:
|
|
docs:
|
|
parent: "functions"
|
|
keywords: [urls,strings]
|
|
godocref:
|
|
signature: ["urlize INPUT"]
|
|
hugoversion:
|
|
deprecated: false
|
|
workson: []
|
|
relatedfuncs: []
|
|
---
|
|
|
|
The following examples pull from a content file with the following front matter:
|
|
|
|
{{< code file="content/blog/greatest-city.md" copy="false">}}
|
|
+++
|
|
title = "The World's Greatest City"
|
|
location = "Chicago IL"
|
|
tags = ["pizza","beer","hot dogs"]
|
|
+++
|
|
{{< /code >}}
|
|
|
|
The following might be used as a partial within a [single page template][singletemplate]:
|
|
|
|
{{< code file="layouts/partials/content-header.html" download="content-header.html" >}}
|
|
<header>
|
|
<h1>{{.Title}}</h1>
|
|
{{ with .Params.location }}
|
|
<div><a href="/locations/{{ . | urlize}}">{{.}}</a></div>
|
|
{{ end }}
|
|
<!-- Creates a list of tags for the content and links to each of their pages -->
|
|
{{ with .Params.tags }}
|
|
<ul>
|
|
{{range .}}
|
|
<li>
|
|
<a href="/tags/{{ . | urlize }}">{{ . }}</a>
|
|
</li>
|
|
{{end}}
|
|
</ul>
|
|
{{ end }}
|
|
</header>
|
|
{{< /code >}}
|
|
|
|
The preceding partial would then output to the rendered page as follows, assuming the page is being built with Hugo's default pretty URLs.
|
|
|
|
{{< output file="/blog/greatest-city/index.html" >}}
|
|
<header>
|
|
<h1>The World's Greatest City</h1>
|
|
<div><a href="/locations/chicago-il">Chicago IL</a></div>
|
|
<ul>
|
|
<li>
|
|
<a href="/tags/pizza">pizza</a>
|
|
</li>
|
|
<li>
|
|
<a href="/tags/beer">beer</a>
|
|
</li>
|
|
<li>
|
|
<a href="/tags/hot-dogs">hot dogs</a>
|
|
</li>
|
|
</ul>
|
|
</header>
|
|
{{< /output >}}
|
|
|
|
|
|
|
|
[singletemplate]: /templates/single-page-templates/
|