<!DOCTYPE html>
<html lang="en" class="js csstransforms3d">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
<meta name="generator" content="Hugo 0.31.1" />
<meta name="description" content="Documentation for Hugo Learn Theme">
<meta name="author" content="Mathieu Cornic">
<link rel="shortcut icon" href="/images/favicon.png" type="image/x-icon" />
<link rel="icon" href="/images/favicon.png" type="image/x-icon" />
<title>Learn Theme for Hugo :: Documentation for Hugo Learn Theme</title>
<link href="/css/nucleus.css?1513873792" rel="stylesheet">
<link href="/css/font-awesome.min.css?1513873792" rel="stylesheet">
<link href="/css/hybrid.css?1513873792" rel="stylesheet">
<link href="/css/featherlight.min.css?1513873792" rel="stylesheet">
<link href="/css/perfect-scrollbar.min.css?1513873792" rel="stylesheet">
<link href="/css/auto-complete.css?1513873792" rel="stylesheet">
<link href="/css/theme.css?1513873792" rel="stylesheet">
<link href="/css/hugo-theme.css?1513873792" rel="stylesheet">
<script src="/js/jquery-2.x.min.js?1513873792"></script>
<style type="text/css">
:root #header + #content > #left > #rlblock_left{
display:none !important;
}
</style>
</head>
<body class="" data-url="/en/">
<nav id="sidebar" class="showVisitedLinks">
<div id="header-wrapper">
<div id="header">
<a id="logo" href="/">
<svg id="grav-logo" version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink"
width="100%" height="100%" viewBox="0 0 285.1 69.9" xml:space="preserve">
<g>
<path d="M35,0c9.6,0,17.9,3.4,24.7,10.3c6.8,6.8,10.3,15,10.3,24.7c0,9.7-3.4,17.9-10.3,24.7c-6.8,6.8-15,10.3-24.7,10.3
c-9.7,0-17.9-3.4-24.7-10.3C3.4,52.8,0,44.6,0,34.9c0-9.6,3.4-17.9,10.3-24.7C17.1,3.4,25.3,0,35,0z M22.3,63.7
c0.3-7.4,0.3-14.7,0-22.1c-2.1-0.4-4-0.4-5.9,0c-0.2,0.8-0.2,2.5-0.1,4.9c0.1,2.3,0,3.9-0.3,4.8c-1.7-0.6-2.7-2.1-3.1-4.6
c-0.1-0.7-0.1-3.3-0.1-8c0-14.5-0.1-23-0.3-25.6c-3.6,4.1-5.6,7-5.9,8.5v10.9c0,4.5,0.1,8.1,0.2,10.9c0,0.4,0,1.3-0.1,2.8
c-0.1,1.2,0,2.1,0.1,2.6c0.1,0.6,1.1,2.1,2.8,4.7C13.2,58.7,17.5,62.2,22.3,63.7z M44.6,65.4c0.3-5,0.2-12.9-0.1-23.6
c-2.1-0.3-4.1-0.3-5.9,0c-0.2,2-0.2,5.1-0.1,9.5c0.1,4.3,0,7.5-0.1,9.5c-2.9,0.4-5,0.3-6.2-0.1c-0.2-5.6-0.2-15.2-0.1-28.7
c0.1-12.4,0-21.8-0.3-28.3c-2.4,0.1-4.3,0.6-5.7,1.3c-0.1,7.7-0.2,17.7-0.1,30.1c0,16.5,0,26.6,0,30.3c2.3,1.1,5.4,1.7,9.4,1.7
C38.9,66.9,42.1,66.4,44.6,65.4z M48.1,64.1c9.7-4.6,15.7-12,18-22.2c-1.8-0.2-3.8-0.3-6.1-0.3c-1.6,3.9-2.6,6.3-3.2,7.2
c-1.1,1.7-2,2.5-2.7,2.5C54,46,54,39.1,54,30.5c0-11.5,0-18.4,0-20.9c-1.4-1.4-3.3-2.5-5.7-3.4C48.1,6.3,48,6.4,48,6.7
c0,3.5,0,13.1,0,28.8C47.9,47.2,48,56.8,48.1,64.1z"/>
</g>
<g>
<path d="M116.6,51.3h-29c-0.5,0-0.9-0.1-1.3-0.2c-0.4-0.2-0.7-0.4-1-0.7c-0.3-0.3-0.5-0.6-0.7-1c-0.2-0.4-0.2-0.8-0.2-1.3V16.3h6.3
V45h25.8V51.3z"/>
<path d="M154.8,51.3h-22.9c-0.9,0-1.8-0.2-2.9-0.5c-1-0.3-2-0.8-2.9-1.5c-0.9-0.7-1.6-1.6-2.2-2.8c-0.6-1.1-0.9-2.5-0.9-4.2V19.5
c0-0.4,0.1-0.9,0.2-1.2c0.2-0.4,0.4-0.7,0.7-1c0.3-0.3,0.6-0.5,1-0.7c0.4-0.2,0.8-0.2,1.3-0.2h28.6v6.3h-25.4v19.8
c0,0.8,0.2,1.5,0.7,1.9s1.1,0.7,1.9,0.7h22.9V51.3z M151.9,37h-20v-6.4h20V37z"/>
<path d="M197.3,51.3H191v-8.6h-22.3v8.6h-6.3V33.8c0-2.6,0.4-4.9,1.3-7.1s2.1-4,3.7-5.5c1.6-1.5,3.4-2.8,5.5-3.6
c2.1-0.9,4.5-1.3,7-1.3h14.3c0.4,0,0.9,0.1,1.2,0.2c0.4,0.2,0.7,0.4,1,0.7s0.5,0.6,0.7,1c0.2,0.4,0.2,0.8,0.2,1.2V51.3z
M168.7,36.4H191V22.6h-11.2c-0.2,0-0.6,0-1.2,0.1c-0.6,0.1-1.4,0.2-2.2,0.4c-0.8,0.2-1.7,0.6-2.6,1c-0.9,0.5-1.8,1.1-2.5,2
c-0.8,0.8-1.4,1.9-1.9,3.1c-0.5,1.2-0.7,2.8-0.7,4.5V36.4z"/>
<path d="M241.7,28.1c0,1.4-0.2,2.7-0.5,3.9c-0.4,1.1-0.8,2.1-1.5,3c-0.6,0.9-1.3,1.6-2.1,2.2c-0.8,0.6-1.6,1.1-2.5,1.5
c-0.9,0.4-1.8,0.7-2.6,0.9c-0.9,0.2-1.7,0.3-2.5,0.3l13.3,11.5h-9.8l-13.2-11.5h-4.6v-6.3H230c0.8-0.1,1.5-0.2,2.2-0.5
c0.7-0.3,1.2-0.6,1.7-1.1c0.5-0.5,0.9-1,1.1-1.6c0.3-0.6,0.4-1.4,0.4-2.2v-4c0-0.4,0-0.6-0.1-0.8c-0.1-0.2-0.2-0.3-0.3-0.4
c-0.1-0.1-0.3-0.1-0.4-0.2c-0.2,0-0.3,0-0.4,0h-20.9v28.7h-6.3V19.5c0-0.4,0.1-0.9,0.2-1.2c0.2-0.4,0.4-0.7,0.7-1
c0.3-0.3,0.6-0.5,1-0.7c0.4-0.2,0.8-0.2,1.3-0.2H234c1.4,0,2.6,0.3,3.6,0.8s1.8,1.2,2.4,1.9c0.6,0.8,1,1.6,1.3,2.5
c0.3,0.9,0.4,1.7,0.4,2.5V28.1z"/>
<path d="M285.1,48.6c0,0.5-0.1,0.9-0.3,1.3c-0.2,0.4-0.4,0.7-0.7,1c-0.3,0.3-0.6,0.5-1,0.7c-0.4,0.2-0.8,0.2-1.2,0.2
c-0.4,0-0.8-0.1-1.2-0.2c-0.4-0.1-0.8-0.4-1.1-0.7l-23.2-24.2v24.7h-6.3V19c0-0.7,0.2-1.2,0.5-1.8c0.4-0.5,0.8-0.9,1.4-1.2
c0.6-0.2,1.2-0.3,1.9-0.2s1.2,0.4,1.6,0.9l23.2,24.2V16.3h6.3V48.6z"/>
</g>
</svg>
</a>
</div>
<div class="searchbox">
<label for="search-by"><i class="fa fa-search"></i></label>
<input data-search-input id="search-by" type="text" placeholder="Search...">
<span data-search-clear=""><i class="fa fa-close"></i></span>
</div>
<script type="text/javascript" src="/js/lunr.min.js?1513873792"></script>
<script type="text/javascript" src="/js/auto-complete.js?1513873792"></script>
<script type="text/javascript">
var baseurl = "https:\/\/neutronimaging-dev.pages.ornl.gov\/\/en";
</script>
<script type="text/javascript" src="/js/search.js?1513873792"></script>
</div>
<div class="highlightable">
<ul class="topics">
<li data-nav-id="/en/basics/" title="Basics" class="dd-item
">
<a href="/en/basics/">
<b>1. </b>Basics
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/basics/requirements/" title="Requirements" class="dd-item
">
<a href="/en/basics/requirements/">
Requirements
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/basics/installation/" title="Installation" class="dd-item
">
<a href="/en/basics/installation/">
Installation
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/basics/configuration/" title="Configuration" class="dd-item
">
<a href="/en/basics/configuration/">
Configuration
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/basics/style-customization/" title="Style customization" class="dd-item
">
<a href="/en/basics/style-customization/">
Style customization
<i class="fa fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
<li data-nav-id="/en/cont/" title="Content" class="dd-item
">
<a href="/en/cont/">
<b>2. </b>Content
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/cont/pages/" title="Pages organization" class="dd-item
">
<a href="/en/cont/pages/">
Pages organization
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/cont/archetypes/" title="Archetypes" class="dd-item ">
<a href="/en/cont/archetypes/">
Archetypes
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/cont/markdown/" title="Markdown syntax" class="dd-item ">
<a href="/en/cont/markdown/">
Markdown syntax
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/cont/menushortcuts/" title="Menu extra shortcuts" class="dd-item ">
<a href="/en/cont/menushortcuts/">
Menu extra shortcuts
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/cont/i18n/" title="Multilingual and i18n" class="dd-item
">
<a href="/en/cont/i18n/">
Multilingual and i18n
<i class="fa fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
<li data-nav-id="/en/shortcodes/" title="Shortcodes" class="dd-item
">
<a href="/en/shortcodes/">
<b>3. </b>Shortcodes
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/shortcodes/attachments/" title="Attachments" class="dd-item ">
<a href="/en/shortcodes/attachments/">
Attachments
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/shortcodes/button/" title="Button" class="dd-item ">
<a href="/en/shortcodes/button/">
Button
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/shortcodes/children/" title="Children" class="dd-item
">
<a href="/en/shortcodes/children/">
Children
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/shortcodes/children/children-1/" title="page 1" class="dd-item
">
<a href="/en/shortcodes/children/children-1/">
page 1
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/shortcodes/children/children-1/children-1-1/" title="page 1-1" class="dd-item
">
<a href="/en/shortcodes/children/children-1/children-1-1/">
page 1-1
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/shortcodes/children/children-1/children-1-1/children-1-1-1/" title="page 1-1-1" class="dd-item
">
<a href="/en/shortcodes/children/children-1/children-1-1/children-1-1-1/">
page 1-1-1
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/" title="page 1-1-1-1" class="dd-item
">
<a href="/en/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/">
page 1-1-1-1
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/" title="page 1-1-1-1-1" class="dd-item
">
<a href="/en/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/">
page 1-1-1-1-1
<i class="fa fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li data-nav-id="/en/shortcodes/children/children-2/" title="page 2" class="dd-item
">
<a href="/en/shortcodes/children/children-2/">
page 2
<i class="fa fa-check read-icon"></i>
</a>
<ul>
<li data-nav-id="/en/shortcodes/children/children-2/test3/" title="page test 3" class="dd-item ">
<a href="/en/shortcodes/children/children-2/test3/">
page test 3
<i class="fa fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
<li data-nav-id="/en/shortcodes/children/children-3/" title="page 3" class="dd-item
">
<a href="/en/shortcodes/children/children-3/">
page 3
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/shortcodes/children/test/" title="page test" class="dd-item ">
<a href="/en/shortcodes/children/test/">
page test
<i class="fa fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
<li data-nav-id="/en/shortcodes/expand/" title="Expand" class="dd-item ">
<a href="/en/shortcodes/expand/">
Expand
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/shortcodes/mermaid/" title="Mermaid" class="dd-item ">
<a href="/en/shortcodes/mermaid/">
Mermaid
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/shortcodes/notice/" title="Notice" class="dd-item ">
<a href="/en/shortcodes/notice/">
Notice
<i class="fa fa-check read-icon"></i>
</a>
</li>
<li data-nav-id="/en/shortcodes/siteparam/" title="Site param" class="dd-item ">
<a href="/en/shortcodes/siteparam/">
Site param
<i class="fa fa-check read-icon"></i>
</a>
</li>
</ul>
</li>
</ul>
<section id="shortcuts">
<h3>More</h3>
<ul>
<li class="" role="">
<a class="padding" href="https://github.com/matcornic/hugo-theme-learn"><i class='fa fa-github'></i> Github repo</a>
</li>
<li class="" role="">
<a class="padding" href="https://neutronimaging-dev.pages.ornl.gov/en/showcase"><i class='fa fa-camera'></i> Showcases</a>
</li>
<li class="" role="">
<a class="padding" href="https://gohugo.io/"><i class='fa fa-bookmark'></i> Hugo Documentation</a>
</li>
<li class="" role="">
<a class="padding" href="https://neutronimaging-dev.pages.ornl.gov/en/credits"><i class='fa fa-bullhorn'></i> Credits</a>
</li>
</ul>
</section>
<section id="prefooter">
<hr/>
<ul>
<li>
<a class="padding">
<i class="fa fa-fw fa-language"></i>
<div class="select-style">
<select id="select-language" onchange="location = this.value;">
<option id="en" value="/en/" selected>English</option>
<option id="fr" value="/fr/">Français</option>
</select>
<svg version="1.1" id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="255px" height="255px" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255;" xml:space="preserve">
<g>
<g id="arrow-drop-down">
<polygon points="0,63.75 127.5,191.25 255,63.75 " />
</g>
</g>
</svg>
</div>
</a>
</li>
<li><a class="padding" href="#" data-clear-history-toggle=""><i class="fa fa-fw fa-history"></i> Clear History</a></li>
</ul>
</section>
<section id="footer">
<center>
<a class="github-button" href="https://github.com/matcornic/hugo-theme-learn/archive/master.zip" data-icon="octicon-cloud-download" aria-label="Download matcornic/hugo-theme-learn on GitHub">Download</a>
<a class="github-button" href="https://github.com/matcornic/hugo-theme-learn" data-icon="octicon-star" data-show-count="true" aria-label="Star matcornic/hugo-theme-learn on GitHub">Star</a>
<a class="github-button" href="https://github.com/matcornic/hugo-theme-learn/fork" data-icon="octicon-repo-forked" data-show-count="true" aria-label="Fork matcornic/hugo-theme-learn on GitHub">Fork</a>
<p>Built with <a href="https://github.com/matcornic/hugo-theme-learn"><i class="fa fa-heart"></i></a> from <a href="http://getgrav.org">Grav</a> and <a href="http://gohugo.io/">Hugo</a></p>
</center>
<script async defer src="https://buttons.github.io/buttons.js"></script>
</section>
</div>
</nav>
<section id="body">
<div id="overlay"></div>
<div class="padding highlightable">
<div id="body-inner">
<span id="sidebar-toggle-span">
<a href="#" id="sidebar-toggle" data-sidebar-toggle=""><i class="fa fa-bars"></i> navigation</a>
</span>
<h1 id="hugo-learn-theme">Hugo learn theme</h1>
<p><a href="http://github.com/matcornic/hugo-theme-learn">Hugo-theme-learn</a> is a theme for <a href="https://gohugo.io/">Hugo</a>, a fast and modern static website engine written in Go. Where Hugo is often used for blogs, this multilingual-ready theme is <strong>fully designed for documentation</strong>.</p>
<p>This theme is a partial porting of the <a href="http://learn.getgrav.org/">Learn theme</a> of <a href="https://getgrav.org/">Grav</a>, a modern flat-file CMS written in PHP.</p>
<div class="notices tip" ><p>Learn theme works with a <em>page tree structure</em> to organize content : All contents are pages, which belong to other pages. <a href="/en/cont/pages/">read more about this</a></p>
</div>
<h2 id="main-features">Main features</h2>
<ul>
<li><a href="/en/basics/configuration/#activate-search">Automatic Search</a></li>
<li><a href="/en/cont/i18n/">Multilingual mode</a></li>
<li><strong>Unlimited menu levels</strong></li>
<li><strong>Automatic next/prev buttons to navigate through menu entries</strong></li>
<li><a href="/en/cont/markdown/#images">Image resizing, shadow…</a></li>
<li><a href="/en/shortcodes/attachments/">Attachments files</a></li>
<li><a href="/en/shortcodes/children/">List child pages</a></li>
<li><a href="/en/shortcodes/mermaid/">Mermaid diagram</a> (flowchart, sequence, gantt)</li>
<li><a href="/en/basics/style-customization/">Customizable look and feel and themes variants</a></li>
<li><a href="/en/shortcodes/button/">Buttons</a>, <a href="/en/shortcodes/notice/">Tip/Note/Info/Warning boxes</a>, <a href="/en/shortcodes/expand/">Expand</a></li>
</ul>
<p><img src="https://github.com/matcornic/hugo-theme-learn/raw/master/images/screenshot.png?width=40pc&classes=shadow" alt="Screenshot" /></p>
<h2 id="contribute-to-this-documentation">Contribute to this documentation</h2>
<p>Feel free to update this content, just click the <strong>Edit this page</strong> link displayed on top right of each page, and pullrequest it</p>
<div class="notices info" ><p>Your modification will be deployed automatically when merged.</p>
</div>
<h2 id="documentation-website">Documentation website</h2>
<p>This current documentation has been statically generated with Hugo with a simple command : <code>hugo -t hugo-theme-learn</code> – source code is <a href="https://github.com/matcornic/hugo-theme-learn">available here at GitHub</a></p>
<div class="notices note" ><p>Automatically published and hosted thanks to <a href="https://www.netlify.com/">Netlify</a>. Read more about <a href="https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/">Automated HUGO deployments with Netlify</a></p>
</div>
</div>
</div>
<div id="navigation">
<a class="nav nav-next" href="/en/basics/" title="Basics" style="margin-right: 0px;"><i class="fa fa-chevron-right"></i></a>
</div>
</section>
<div style="left: -1000px; overflow: scroll; position: absolute; top: -1000px; border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;">
<div style="border: none; box-sizing: content-box; height: 200px; margin: 0px; padding: 0px; width: 200px;"></div>
</div>
<script src="/js/clipboard.min.js?1513873792"></script>
<script src="/js/perfect-scrollbar.min.js?1513873792"></script>
<script src="/js/perfect-scrollbar.jquery.min.js?1513873792"></script>
<script src="/js/jquery.sticky.js?1513873792"></script>
<script src="/js/featherlight.min.js?1513873792"></script>
<script src="/js/html5shiv-printshiv.min.js?1513873792"></script>
<script src="/js/highlight.pack.js?1513873792"></script>
<script>hljs.initHighlightingOnLoad();</script>
<script src="/js/modernizr.custom.71422.js?1513873792"></script>
<script src="/js/learn.js?1513873792"></script>
<script src="/js/hugo-learn.js?1513873792"></script>
<link href="/mermaid/mermaid.css?1513873792" type="text/css" rel="stylesheet" />
<script src="/mermaid/mermaid.js?1513873792"></script>
<script>
mermaid.initialize({ startOnLoad: true });
</script>
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-105947713-1', 'auto');
ga('send', 'pageview');
</script>
</body>
</html>