<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <meta http-equiv="X-UA-Compatible" content="ie=edge"> <link rel="stylesheet" href="../../../static/styles.css?h=dff0aaad"> <link rel="stylesheet" href="../../../static/pygments.css"> <link rel="shortcut icon" href="../../../static/favicon.png?h=fa09bedd"> <title>Sitemap | Documentation | Lektor Static Content Management System</title> </head> <body class="default"> <nav class="navbar navbar-inverse navbar-static-top"> <div class="container"> <div class="navbar-header"> <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar" aria-expanded="false" aria-controls="navbar"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button> <a class="navbar-brand" href="../../../">Lektor</a> </div> <div id="navbar" class="collapse navbar-collapse"> <ul class="nav navbar-nav"> <li><a href="../../../downloads/">Download</a></li> <li class="active"><a href="../../">Documentation</a></li> <li><a href="../../../showcase/">Showcase</a></li> <li><a href="../../../plugins/">Plugins</a></li> <li><a href="../../../community/">Community</a></li> <li><a href="../../../blog/">Blog</a></li> </ul> </div> </div> </nav> <div class="body-wrapper"> <div class="container"> <div class="row"> <div class="col-sm-3"> <ul class="tree-nav nocontent"> <li><a href="../../">Welcome</a></li> <li><a href="../../what/">What is Lektor</a> <li><a href="../../installation/">Installation</a> <li><a href="../../quickstart/">Quickstart</a> <li><a href="../../project/">Project</a> <li><a href="../../content/">Content</a> <li><a href="../../templates/">Templates</a> <li><a href="../../themes/">Themes</a> <li><a href="../">Guides</a> <ul> <li><a href="../blog/">Blog</a> <li><a href="../categories/">Categories</a> <li><a href="../disqus/">Disqus Comments</a> <li><a href="../error-pages/">Error Pages</a> <li><a href="../page-order/">Page Order</a> <li><a href="../pagination/">Pagination</a> <li><a href="../portfolio/">Portfolio Sites</a> <li><a href="../redirects/">Redirects</a> <li><a href="../single-page/">Single-Page</a> <li class="active"><a href="./">Sitemap</a> <ul></ul> <li><a href="../webpack/">Webpack</a> </ul> <li><a href="../../deployment/">Deployment</a> <li><a href="../../plugins/">Plugins</a> <li><a href="../../models/">Data Modelling</a> <li><a href="../../cli/">Command Line</a> <li><a href="../../api/">API</a> <li><a href="../../search/">Search</a> </ul> <div class="visible-md-block visible-lg-block"> <h4>This Page</h4> <ul class="toc"> <li><a href="#contents-file">Contents File</a></li> <li><a href="#template-file">Template File</a></li> <li><a href="#human-readable-sitemap">Human Readable Sitemap</a></li> </ul> </div> </div> <div class="col-sm-9 doc-styling"> <h1>Sitemap</h1> <ul class=page-meta> </ul> <p>If you want to have a <code>sitemap.xml</code> file for search engines this is something you can very easily create yourself. All you need is a contents file and a custom template.</p> <h2 id="contents-file">Contents File</h2><p>First we need to create a contents file. Since <code>sitemap.xml</code> always goes into the same location we create a folder called <code>sitemap.xml</code> inside our <code>content</code> folder and add a <code>contents.lr</code> file with the following data:</p> <pre><code>_template: sitemap.xml --- _model: none </code></pre> <p>This instructs Lektor to use the template <code>sitemap.xml</code> for this page. We also give it the empty <code>none</code> model for good measure.</p> <div class="admonition admonition-tip"><p>Starting with Lektor 2.0 you can also add <code>_discoverable: no</code> as a field into the file to hide it from <code>.children</code>. This is useful for such special pages which should be excluded from navigation or automatic link generation.</p></div><h2 id="template-file">Template File</h2><p>The template loaded will be <code>templates/sitemap.xml</code>. In this file we just iterate over all pages of the site recursively. This also automatically skips hidden pages so those will not be generated out.</p> <div class="hll"><pre><span></span><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span> <span class="nt"><urlset</span><span class="w"> </span><span class="na">xmlns=</span><span class="s">"http://www.sitemaps.org/schemas/sitemap/0.9"</span><span class="nt">></span> <span class="w"> </span><span class="cp">{%</span>- <span class="k">for</span> <span class="nv">page</span> <span class="k">in</span> <span class="o">[</span><span class="nv">site.root</span><span class="o">]</span> <span class="k">if</span> <span class="nv">page</span> <span class="o">!=</span> <span class="nv">this</span> <span class="k">recursive</span> <span class="cp">%}</span> <span class="w"> </span><span class="nt"><url><loc></span><span class="cp">{{</span> <span class="nv">page</span><span class="o">|</span><span class="nf">url</span><span class="o">(</span><span class="nv">external</span><span class="o">=</span><span class="kp">true</span><span class="o">)</span> <span class="cp">}}</span><span class="nt"></loc></url></span> <span class="w"> </span><span class="cp">{{</span><span class="o">-</span> <span class="nb">loop</span><span class="o">(</span><span class="nv">page.children</span><span class="o">|</span><span class="nf">sort</span><span class="o">(</span><span class="nv">attribute</span><span class="o">=</span><span class="s1">'path'</span><span class="o">))</span> <span class="cp">}}</span> <span class="w"> </span><span class="cp">{%</span>- <span class="k">endfor</span> <span class="cp">%}</span> <span class="nt"></urlset></span> </pre></div> <p>Sorting the page using <code>|sort(attribute='path')</code> is not mandatory, but can be useful if you prefer to have stable builds, for instance if you use <code>git</code> to version the generated page and would like a clean history or a meaningful diff from the last build.</p> <p>Note that because sitemaps need to have external URLs (with scheme and everything) you will need to configure the <code>url</code> of the site before the template starts working. For more information see <a href="../../project/file/#project" class="ref">Project File</a></p> <h2 id="human-readable-sitemap">Human Readable Sitemap</h2><p>But what if you want a beautiful sitemap as a tree for human reading? This is not any harder. Instead of making a <code>sitemap.xml/contents.lr</code> file just create a <code>sitemap/contents.lr</code> file instead and use a template like <code>sitemap.html</code>. Then use something like this:</p> <div class="hll"><pre><span></span><span class="cp">{%</span> <span class="k">extends</span> <span class="s2">"layout.html"</span> <span class="cp">%}</span> <span class="cp">{%</span> <span class="k">block</span> <span class="nv">title</span> <span class="cp">%}</span>Sitemap<span class="cp">{%</span> <span class="k">endblock</span> <span class="cp">%}</span> <span class="cp">{%</span> <span class="k">block</span> <span class="nv">body</span> <span class="cp">%}</span> <span class="p"><</span><span class="nt">ul</span> <span class="na">class</span><span class="o">=</span><span class="s">"sitemap"</span><span class="p">></span> <span class="cp">{%</span> <span class="k">for</span> <span class="nv">page</span> <span class="k">in</span> <span class="o">[</span><span class="nv">site.root</span><span class="o">]</span> <span class="k">if</span> <span class="nv">page.record_label</span> <span class="k">recursive</span> <span class="cp">%}</span> <span class="p"><</span><span class="nt">li</span><span class="p">><</span><span class="nt">a</span> <span class="na">href</span><span class="o">=</span><span class="s">"</span><span class="cp">{{</span> <span class="nv">page</span><span class="o">|</span><span class="nf">url</span> <span class="cp">}}</span><span class="s">"</span><span class="p">></span><span class="cp">{{</span> <span class="nv">page.record_label</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">a</span><span class="p">></span> <span class="cp">{%</span> <span class="k">if</span> <span class="nv">page.children</span> <span class="cp">%}</span> <span class="p"><</span><span class="nt">ul</span><span class="p">></span><span class="cp">{{</span> <span class="nb">loop</span><span class="o">(</span><span class="nv">page.children</span><span class="o">|</span><span class="nf">sort</span><span class="o">(</span><span class="nv">attribute</span><span class="o">=</span><span class="s1">'path'</span><span class="o">))</span> <span class="cp">}}</span><span class="p"></</span><span class="nt">ul</span><span class="p">></span> <span class="cp">{%</span> <span class="k">endif</span> <span class="cp">%}</span> <span class="p"></</span><span class="nt">li</span><span class="p">></span> <span class="cp">{%</span> <span class="k">endfor</span> <span class="cp">%}</span> <span class="p"></</span><span class="nt">ul</span><span class="p">></span> <span class="cp">{%</span> <span class="k">endblock</span> <span class="cp">%}</span> </pre></div> <div class="comment-box"> <h2>Comments</h2> <div id="disqus_thread"></div> <script> var disqus_config = function() { this.page.identifier = "/docs/guides/sitemap"; this.page.url = "https://www.getlektor.com/docs/guides/sitemap/"; }; (function() { var d = document, s = d.createElement('script'); s.src = '//lektordocumentation.disqus.com/embed.js'; s.setAttribute('data-timestamp', +new Date()); (d.head || d.body).appendChild(s); })(); </script> <noscript> Please enable JavaScript to view the <a href="https://disqus.com/?ref_noscript" rel="nofollow">comments powered by Disqus.</a> </noscript> </div> </div> </div> </div> </div> <div class="bottomsummary"> <div class="container"> </div> </div> <footer> <div class="container"> <div class="row"> <div class="col-sm-4 icon-bar"> <a href="https://github.com/lektor/lektor/" title="Lektor on GitHub" ><i class="fa fa-github"></i></a> <a href="https://github.com/lektor/lektor/issues/" title="Report Issues for Lektor" ><i class="fa fa-bug"></i></a> <a href="https://twitter.com/getlektor" title="Find Lektor on Twitter" ><i class="fa fa-twitter"></i></a> <a href="https://gitter.im/lektor/lektor" title="Chat on Gitter" ><i class="fa fa-comment"></i></a> <a href="https://github.com/lektor/lektor-website/tree/master/content/docs/guides/sitemap/contents.lr" title="View source for this page"><i class="fa fa-code"></i></a> </div> <div class="col-sm-8"> <a href="../../../license/">License & Copyright</a> • <a href="../../../contact/">Contact</a> • Made with <i class="fa fa-fw fa-heart" title="Heart"><span hidden>Heart</span></i> in Carinthia </div> </div> </div> </footer> <script type=text/javascript src="../../../static/app.js?h=250c2aed" charset="utf-8"></script> <script> ((window.gitter = {}).chat = {}).options = { room: 'lektor/lektor', activationElement: null }; document.write('<button class="js-gitter-toggle-chat-button">Toggle Chat</button>'); var dnt = navigator.doNotTrack || window.doNotTrack || navigator.msDoNotTrack; if (dnt != "1" && dnt != "yes") { window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date; ga('create', 'UA-70822533-1', 'auto'); ga('set', 'anonymizeIp', true); ga('send', 'pageview'); } else { console.debug("Respecting Do-Not-Track, not running analytics."); } </script> <script async src='https://www.google-analytics.com/analytics.js'></script> <script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script> <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script> <script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script> </body> </html>