From 5df0cf7ecac3240c57fd2d3b3cf3f4eb9c966dc4 Mon Sep 17 00:00:00 2001 From: Vincent Batoufflet Date: Wed, 7 May 2014 08:58:25 +0200 Subject: [PATCH] Add Sitemap documentation content --- docs/content/layout/sitemap.md | 47 +++++++++++++++++++++++ docs/content/overview/source-directory.md | 5 ++- examples/blog/layouts/sitemap.xml | 10 +++++ 3 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 docs/content/layout/sitemap.md create mode 100644 examples/blog/layouts/sitemap.xml 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
+**.Sitemap.Priority** The priority of the page
+ +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 %}} + + {{ range .Data.Pages }} + + {{ .Permalink }} + {{ safeHtml ( .Date.Format "2006-01-02T15:04:05-07:00" ) }}{{ with .Sitemap.ChangeFreq }} + {{ . }}{{ end }}{{ if ge .Sitemap.Priority 0.0 }} + {{ .Sitemap.Priority }}{{ end }} + + {{ end }} + +{{% /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.* + + 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 @@ + + {{ range .Data.Pages }} + + {{ .Permalink }} + {{ safeHtml ( .Date.Format "2006-01-02T15:04:05-07:00" ) }}{{ with .Sitemap.ChangeFreq }} + {{ . }}{{ end }}{{ if ge .Sitemap.Priority 0.0 }} + {{ .Sitemap.Priority }}{{ end }} + + {{ end }} +