Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorVincent Batoufflet <vincent@batoufflet.info>2014-05-07 10:58:25 +0400
committerspf13 <steve.francia@gmail.com>2014-05-10 07:11:48 +0400
commit5df0cf7ecac3240c57fd2d3b3cf3f4eb9c966dc4 (patch)
tree61226137f8ae2640a10abdb7c3b86c9261adbfe3
parent35926dcf3742df915a9d535d7178a363c666e840 (diff)
Add Sitemap documentation content
-rw-r--r--docs/content/layout/sitemap.md47
-rw-r--r--docs/content/overview/source-directory.md5
-rw-r--r--examples/blog/layouts/sitemap.xml10
3 files changed, 60 insertions, 2 deletions
diff --git a/docs/content/layout/sitemap.md b/docs/content/layout/sitemap.md
new file mode 100644
index 000000000..b2cf151a3
--- /dev/null
+++ b/docs/content/layout/sitemap.md
@@ -0,0 +1,47 @@
+---
+title: "Sitemap Template"
+date: "2014-05-07"
+weight: 45
+notoc: true
+menu:
+ main:
+ parent: 'layout'
+---
+
+A single Sitemap template is used to generate the `sitemap.xml` file.
+
+This page is of the type "node" and have all the [node
+variables](/layout/variables/) available to use in this template
+along with Sitemap-specific ones:
+
+**.Sitemap.ChangeFreq** The page change frequency<br>
+**.Sitemap.Priority** The priority of the page<br>
+
+In addition to the standard node variables, the homepage has access to all
+site pages through `.Data.Pages`.
+
+ ▾ layouts/
+ sitemap.xml
+
+## sitemap.xml
+
+This template respects the version 0.9 of the [Sitemap
+Protocol](http://www.sitemaps.org/protocol.html).
+
+{{% highlight xml %}}
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+ {{ range .Data.Pages }}
+ <url>
+ <loc>{{ .Permalink }}</loc>
+ <lastmod>{{ safeHtml ( .Date.Format "2006-01-02T15:04:05-07:00" ) }}</lastmod>{{ with .Sitemap.ChangeFreq }}
+ <changefreq>{{ . }}</changefreq>{{ end }}{{ if ge .Sitemap.Priority 0.0 }}
+ <priority>{{ .Sitemap.Priority }}</priority>{{ end }}
+ </url>
+ {{ end }}
+</urlset>
+{{% /highlight %}}
+
+*Important: Hugo will automatically add the following header line to this file
+on render...please don't include this in the template as it's not valid HTML.*
+
+ <?xml version="1.0" encoding="utf-8" standalone="yes" ?>
diff --git a/docs/content/overview/source-directory.md b/docs/content/overview/source-directory.md
index 28e4dee57..54fb8272c 100644
--- a/docs/content/overview/source-directory.md
+++ b/docs/content/overview/source-directory.md
@@ -11,7 +11,7 @@ menu:
Hugo takes a single directory and uses it as the input for creating a complete website.
-Hugo has a very small amount of configuration, while remaining highly customizable.
+Hugo has a very small amount of configuration, while remaining highly customizable.
It accomplishes by assuming that you will only provide templates with the intent of
using them.
@@ -48,7 +48,8 @@ An example directory may look like:
| | ├── vimeo.html
| | └── youtube.html
| ├── index.html
- | └── rss.xml
+ | ├── rss.xml
+ | └── sitemap.xml
└── static
This directory structure tells us a lot about this site:
diff --git a/examples/blog/layouts/sitemap.xml b/examples/blog/layouts/sitemap.xml
new file mode 100644
index 000000000..2cc760811
--- /dev/null
+++ b/examples/blog/layouts/sitemap.xml
@@ -0,0 +1,10 @@
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+ {{ range .Data.Pages }}
+ <url>
+ <loc>{{ .Permalink }}</loc>
+ <lastmod>{{ safeHtml ( .Date.Format "2006-01-02T15:04:05-07:00" ) }}</lastmod>{{ with .Sitemap.ChangeFreq }}
+ <changefreq>{{ . }}</changefreq>{{ end }}{{ if ge .Sitemap.Priority 0.0 }}
+ <priority>{{ .Sitemap.Priority }}</priority>{{ end }}
+ </url>
+ {{ end }}
+</urlset>