marcel
/
congo
mirror of https://github.com/jpanther/congo.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
congo/docs/content-examples/index.html

459 lines
43 KiB
HTML
Raw Blame History

<!doctype html><html lang=en-au dir=ltr class=scroll-smooth data-default-appearance=light data-auto-appearance=true><head>
<meta charset=utf-8>
<meta http-equiv=content-language content="en-au">
<meta name=viewport content="width=device-width,initial-scale=1">
<meta http-equiv=x-ua-compatible content="ie=edge">
<title>Content Examples &#183; Congo</title>
<meta name=title content="Content Examples &#183; Congo">
<meta name=description content="A powerful, lightweight theme for Hugo built with Tailwind CSS.">
<link rel=canonical href=https://jpanther.github.io/congo/docs/content-examples/>
<link type=text/css rel=stylesheet href=/congo/css/main.bundle.min.8668fddbcbb932886633e4aa81083d40daba23f947de11d220d65a81de2f1d305d46f22ba639bfadba00f888260183fce15757d95b0f94ea337f3361f3ccf098.css integrity="sha512-hmj928u5MohmM+SqgQg9QNq6I/lH3hHSINZagd4vHTBdRvIrpjm/rboA+IgmAYP84VdX2VsPlOozfzNh88zwmA==">
<script defer type=text/javascript id=script-bundle src=/congo/js/main.bundle.min.ac8bae0637d2c85a05cf0fb654b22607333000c82c6c5222850c59bef9243e6ea1233806da173e50066dc88f4da82b08a9a64e27104c31d56d4d02a05a7efbae.js integrity="sha512-rIuuBjfSyFoFzw+2VLImBzMwAMgsbFIihQxZvvkkPm6hIzgG2hc+UAZtyI9NqCsIqaZOJxBMMdVtTQKgWn77rg==" data-copy=Copy data-copied=Copied></script>
<link rel=apple-touch-icon sizes=180x180 href=/congo/apple-touch-icon.png>
<link rel=icon type=image/png sizes=32x32 href=/congo/favicon-32x32.png>
<link rel=icon type=image/png sizes=16x16 href=/congo/favicon-16x16.png>
<link rel=manifest href=/congo/site.webmanifest>
<meta property="og:title" content="Content Examples">
<meta property="og:description" content="All the partials available in Congo.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://jpanther.github.io/congo/docs/content-examples/"><meta property="article:section" content="docs">
<meta property="article:published_time" content="2020-08-09T00:00:00+00:00">
<meta property="article:modified_time" content="2020-08-09T00:00:00+00:00"><meta property="og:site_name" content="Congo">
<meta name=twitter:card content="summary">
<meta name=twitter:title content="Content Examples">
<meta name=twitter:description content="All the partials available in Congo.">
<script type=application/ld+json>[{"@context":"https://schema.org","@type":"Article","articleSection":"Documentation","name":"Content Examples","headline":"Content Examples","description":"All the partials available in Congo.","abstract":"If you\u0026rsquo;ve been reading the documentation in order, you should now know about all the features and configurations available in Congo.","inLanguage":"en-au","url":"https:\/\/jpanther.github.io\/congo\/docs\/content-examples\/","author":{"@type":"Person","name":"Congo"},"copyrightYear":"2020","dateCreated":"2020-08-09T00:00:00\u002b00:00","datePublished":"2020-08-09T00:00:00\u002b00:00","dateModified":"2020-08-09T00:00:00\u002b00:00","keywords":["content","example"],"mainEntityOfPage":"true","wordCount":"1827"}]</script>
<meta name=generator content="Hugo 0.92.1">
<meta name=author content="Congo">
<link href=https://twitter.com/ rel=me>
<link href=https://facebook.com/ rel=me>
<link href=https://linkedin.com/ rel=me>
<link href=https://youtube.com/ rel=me>
</head>
<body class="flex flex-col h-screen px-6 m-auto text-lg leading-7 bg-neutral text-neutral-900 sm:px-14 md:px-24 lg:px-32 dark:bg-neutral-800 dark:text-neutral max-w-7xl">
<div id=the-top class="absolute flex self-center">
<a class="px-3 py-1 text-sm -translate-y-8 rounded-b-lg bg-primary-200 dark:bg-neutral-600 focus:translate-y-0" href=#main-content><span class="font-bold ltr:pr-2 rtl:pl-2 text-primary-600 dark:text-primary-400">&darr;</span>Skip to main content</a>
</div><header class="flex justify-between py-6 font-semibold sm:items-center sm:py-10 text-neutral-900 dark:text-neutral">
<div>
<a class="hover:underline hover:decoration-primary-500 hover:decoration-2 hover:underline-offset-2" rel=me href=/congo/>Congo</a>
</div>
<nav>
<ul class="flex flex-col list-none sm:flex-row">
<li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0">
<a class="hover:underline hover:decoration-primary-500 hover:decoration-2 hover:underline-offset-2" href=/congo/docs/ title=Documentation>Docs</a>
</li>
<li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0">
<a class="hover:underline hover:decoration-primary-500 hover:decoration-2 hover:underline-offset-2" href=/congo/samples/ title="Content Samples">Samples</a>
</li>
<li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0">
<a class="hover:underline hover:decoration-primary-500 hover:decoration-2 hover:underline-offset-2" href=/congo/users/ title=Users>Users</a>
</li>
<li class="mb-1 ltr:text-right rtl:text-left sm:mb-0 ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0">
<a class="hover:underline hover:decoration-primary-500 hover:decoration-2 hover:underline-offset-2" href=https://github.com/jpanther/congo title>GitHub</a>
</li>
<li class="ltr:text-right rtl:text-left ltr:sm:mr-7 ltr:sm:last:mr-0 rtl:sm:ml-7 rtl:sm:last:ml-0">
<button id=search-button class="text-base hover:text-primary-600 dark:hover:text-primary-400" title="Search (/)">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="search" class="svg-inline--fa fa-search fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentcolor" d="M505 442.7 405.3 343c-4.5-4.5-10.6-7-17-7H372c27.6-35.3 44-79.7 44-128C416 93.1 322.9.0 208 0S0 93.1.0 208s93.1 208 208 208c48.3.0 92.7-16.4 128-44v16.3c0 6.4 2.5 12.5 7 17l99.7 99.7c9.4 9.4 24.6 9.4 33.9.0l28.3-28.3c9.4-9.4 9.4-24.6.1-34zM208 336c-70.7.0-128-57.2-128-128 0-70.7 57.2-128 128-128 70.7.0 128 57.2 128 128 0 70.7-57.2 128-128 128z"/></svg>
</span>
</button>
</li>
</ul>
</nav>
</header>
<main id=main-content class=relative>
<article>
<header class=max-w-prose>
<ol class="text-sm text-neutral-500 dark:text-neutral-400">
<li class="inline hidden">
<a class="hover:underline hover:decoration-neutral-300 dark:underline-neutral-600" href=/congo/>Welcome to Congo! :tada:</a><span class="px-1 text-primary-500">/</span>
</li>
<li class=inline>
<a class="hover:underline hover:decoration-neutral-300 dark:underline-neutral-600" href=/congo/docs/>Documentation</a><span class="px-1 text-primary-500">/</span>
</li>
<li class="inline hidden">
<a class="hover:underline hover:decoration-neutral-300 dark:underline-neutral-600" href=/congo/docs/content-examples/>Content Examples</a><span class="px-1 text-primary-500">/</span>
</li>
</ol>
<h1 class="mt-0 text-4xl font-extrabold text-neutral-900 dark:text-neutral">
Content Examples
</h1>
<div class="mt-8 mb-12 text-base text-neutral-500 dark:text-neutral-400">
<div class="flex flex-row flex-wrap items-center">
<span title="Reading time">9 mins</span><span class="px-2 text-primary-500">&#183;</span>
<span class=mb-[2px]>
<a href=https://github.com/jpanther/congo/tree/dev/exampleSite/content/docs/content-examples.md class="text-lg hover:text-primary-500" rel="noopener noreferrer" target=_blank title="Edit content">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="far" data-icon="edit" class="svg-inline--fa fa-edit fa-w-18" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path fill="currentcolor" d="M402.3 344.9l32-32c5-5 13.7-1.5 13.7 5.7V464c0 26.5-21.5 48-48 48H48c-26.5.0-48-21.5-48-48V112c0-26.5 21.5-48 48-48h273.5c7.1.0 10.7 8.6 5.7 13.7l-32 32c-1.5 1.5-3.5 2.3-5.7 2.3H48v352h352V350.5c0-2.1.8-4.1 2.3-5.6zm156.6-201.8L296.3 405.7l-90.4 10c-26.2 2.9-48.5-19.2-45.6-45.6l10-90.4L432.9 17.1c22.9-22.9 59.9-22.9 82.7.0l43.2 43.2c22.9 22.9 22.9 60 .1 82.8zM460.1 174 402 115.9 216.2 301.8l-7.3 65.3 65.3-7.3L460.1 174zm64.8-79.7-43.2-43.2c-4.1-4.1-10.8-4.1-14.8.0L436 82l58.1 58.1 30.9-30.9c4-4.2 4-10.8-.1-14.9z"/></svg>
</span>
</a>
</span>
</div>
</div>
</header>
<section class="flex flex-col max-w-full mt-0 prose lg:flex-row dark:prose-invert">
<div class="order-first px-0 lg:max-w-xs ltr:lg:pl-8 rtl:lg:pr-8 lg:order-last">
<div class="ltr:pl-5 rtl:pr-5 toc lg:sticky lg:top-10">
<details open class="mt-0 overflow-hidden rounded-lg rtl:pr-5 ltr:pl-5 ltr:-ml-5 rtl:-mr-5 lg:mt-3">
<summary class="block py-1 text-lg font-semibold cursor-pointer rtl:pr-5 ltr:pl-5 ltr:-ml-5 rtl:-mr-5 text-neutral-800 dark:text-neutral-100 lg:hidden bg-neutral-100 dark:bg-neutral-700">
Table of Contents
</summary>
<div class="py-2 border-dotted ltr:border-l rtl:border-r rtl:pr-5 ltr:pl-5 ltr:-ml-5 rtl:-mr-5 border-neutral-300 dark:border-neutral-600">
<nav id=TableOfContents>
<ul>
<li><a href=#branch-pages>Branch pages</a>
<ul>
<li><a href=#homepage>Homepage</a></li>
<li><a href=#list-pages>List pages</a></li>
<li><a href=#taxonomy-pages>Taxonomy pages</a></li>
</ul>
</li>
<li><a href=#leaf-pages>Leaf pages</a>
<ul>
<li><a href=#external-links>External links</a></li>
</ul>
</li>
<li><a href=#custom-layouts>Custom layouts</a>
<ul>
<li><a href=#overriding-default-layouts>Overriding default layouts</a></li>
<li><a href=#custom-section-layouts>Custom section layouts</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</details>
</div>
</div>
<div class="min-w-0 min-h-0 max-w-prose">
<p>If you&rsquo;ve been reading the documentation in order, you should now know about all the features and configurations available in Congo. This page is designed to pull everything together and offer some worked examples that you might like to use in your Hugo project.</p>
<div class="flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900">
<span class="ltr:pr-3 rtl:pl-3 text-primary-400">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="exclamation-triangle" class="svg-inline--fa fa-exclamation-triangle fa-w-18" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><path fill="currentcolor" d="M569.517 440.013C587.975 472.007 564.806 512 527.94 512H48.054c-36.937.0-59.999-40.055-41.577-71.987L246.423 23.985c18.467-32.009 64.72-31.951 83.154.0l239.94 416.028zM288 354c-25.405.0-46 20.595-46 46s20.595 46 46 46 46-20.595 46-46-20.595-46-46-46zm-43.673-165.346 7.418 136c.347 6.364 5.609 11.346 11.982 11.346h48.546c6.373.0 11.635-4.982 11.982-11.346l7.418-136c.375-6.874-5.098-12.654-11.982-12.654h-63.383c-6.884.0-12.356 5.78-11.981 12.654z"/></svg>
</span>
</span>
<span class=dark:text-neutral-300><strong>Tip:</strong> If you&rsquo;re new to Hugo, be sure to check out the <a href=https://gohugo.io/content-management/page-bundles/>official docs</a> to learn more about the concept of page bundles and resources.</span>
</div>
<p>The examples on this page can all be adapted to different scenarios but hopefully give you some ideas about how to approach formatting a particular content item for your individual project.</p>
<h2 id=branch-pages class="relative group">Branch pages <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#branch-pages aria-label=Anchor>#</a></span></h2>
<p>Branch page bundles in Hugo cover items like the homepage, section listings, and taxonomy pages. The important thing to remember about branch bundles is that the filename for this content type is <strong><code>_index.md</code></strong>.</p>
<p>Congo will honour the front matter parameters specified in branch pages and these will override the default settings for that particular page. For example, setting the <code>title</code> parameter in a branch page will allow overriding the page title.</p>
<h3 id=homepage class="relative group">Homepage <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#homepage aria-label=Anchor>#</a></span></h3>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Layout:</strong></td>
<td><code>layouts/index.html</code></td>
</tr>
<tr>
<td><strong>Content:</strong></td>
<td><code>content/_index.md</code></td>
</tr>
</tbody>
</table>
<p>The homepage in Congo is special in that it&rsquo;s overarching design is controlled by the homepage layout config parameter. You can learn more about this in the <a href=https://jpanther.github.io/congo/docs/homepage-layout/>Homepage Layout</a> section.</p>
<p>If you want to add custom content to this page, you simply need to create a <code>content/_index.md</code> file. Anything in this file will then be included in your homepage.</p>
<p><strong>Example:</strong></p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-yaml data-lang=yaml><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=nt>title</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;Welcome to Congo!&#34;</span><span class=w>
</span><span class=w></span><span class=nt>description</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;This is a demo of adding content to the homepage.&#34;</span><span class=w>
</span><span class=w></span><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=l>Welcome to my website! I&#39;m really happy you stopped by.</span><span class=w>
</span></code></pre></div><p><em>This example sets a custom title and adds some additional text to the body of the page. Any Markdown formatted text is acceptable, including shortcodes, images and links.</em></p>
<h3 id=list-pages class="relative group">List pages <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#list-pages aria-label=Anchor>#</a></span></h3>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Layout:</strong></td>
<td><code>layouts/_default/list.html</code></td>
</tr>
<tr>
<td><strong>Content:</strong></td>
<td><code>content/../_index.md</code></td>
</tr>
</tbody>
</table>
<p>List pages group all the pages within into a section and provide a way for visitors to reach each page. A blog or portfolio are examples of a list page as they group together posts or projects.</p>
<p>Creating a list page is as simple as making a sub-directory in the content folder. For example, to create a &ldquo;Projects&rdquo; section, you would create <code>content/projects/</code>. Then create a Markdown file for each of your projects.</p>
<p>A list page will be generated by default, however to customise the content, you should also create an <code>_index.md</code> page in this new directory.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell>.
└── content
└── projects
├── _index.md <span class=c1># /projects</span>
├── first-project.md <span class=c1># /projects/first-project</span>
└── another-project
├── index.md <span class=c1># /projects/another-project</span>
└── project.jpg
</code></pre></div><p>Hugo will generate URLs for the pages in your projects folder accordingly.</p>
<p>Just like the homepage, content in the <code>_index.md</code> file will be output into the generated list index. Congo will then list any pages in this section below the content.</p>
<p><strong>Example:</strong></p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-yaml data-lang=yaml><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=nt>title</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;Projects&#34;</span><span class=w>
</span><span class=w></span><span class=nt>description</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;Learn about some of my projects.&#34;</span><span class=w>
</span><span class=w></span><span class=nt>cascade</span><span class=p>:</span><span class=w>
</span><span class=w> </span><span class=nt>showReadingTime</span><span class=p>:</span><span class=w> </span><span class=kc>false</span><span class=w>
</span><span class=w></span><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=l>This section contains all my current projects.</span><span class=w>
</span></code></pre></div><p><em>In this example, the special <code>cascade</code> parameter is being used to hide the reading time on any sub-pages within this section. By doing this, any project pages will not have their reading time showing. This is a great way to override default theme parameters for an entire section without having to include them in every individual page.</em></p>
<p>The <a href=https://jpanther.github.io/congo/samples/>samples section</a> of this site is an example of a list page.</p>
<h3 id=taxonomy-pages class="relative group">Taxonomy pages <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#taxonomy-pages aria-label=Anchor>#</a></span></h3>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>List layout:</strong></td>
<td><code>layouts/_default/taxonomy.html</code></td>
</tr>
<tr>
<td><strong>Term layout:</strong></td>
<td><code>layouts/_default/term.html</code></td>
</tr>
<tr>
<td><strong>Content:</strong></td>
<td><code>content/../_index.md</code></td>
</tr>
</tbody>
</table>
<p>Taxonomy pages come in two forms - taxonomy lists and taxonomy terms. Lists display a listing of each of the terms within a given taxonomy, while terms display a list of pages that are related to a given term.</p>
<p>The terminology can get a little confusing so let&rsquo;s explore an example using a taxonomy named <code>animals</code>.</p>
<p>Firstly, to use taxonomies in Hugo, they have to be configured. This is done by creating a config file at <code>config/_default/taxonomies.toml</code> and defining the taxonomy name.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-toml data-lang=toml><span class=c># config/_default/taxonomies.toml</span>
<span class=nx>animal</span> <span class=p>=</span> <span class=s2>&#34;animals&#34;</span>
</code></pre></div><p>Hugo expects taxonomies to be listed using their singular and plural forms, so we add the singular <code>animal</code> equals the plural <code>animals</code> to create our example taxonomy.</p>
<p>Now that our <code>animals</code> taxonomy exists, it needs to be added to individual content items. It&rsquo;s as simple as inserting it into the front matter:</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-yaml data-lang=yaml><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=nt>title</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;Into the Lion&#39;s Den&#34;</span><span class=w>
</span><span class=w></span><span class=nt>description</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;This week we&#39;re learning about lions.&#34;</span><span class=w>
</span><span class=w></span><span class=nt>animals</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=s2>&#34;lion&#34;</span><span class=p>,</span><span class=w> </span><span class=s2>&#34;cat&#34;</span><span class=p>]</span><span class=w>
</span><span class=w></span><span class=nn>---</span><span class=w>
</span></code></pre></div><p>This has now created two <em>terms</em> within our <code>animals</code> taxonomy - <code>lion</code> and <code>cat</code>.</p>
<p>Although it&rsquo;s not obvious at this point, Hugo will now be generating list and term pages for this new taxonomy. By default the listing can be accessed at <code>/animals/</code> and the term pages can be found at <code>/animals/lion/</code> and <code>/animals/cat/</code>.</p>
<p>The list page will list all the terms contained within the taxonomy. In this example, navigating to <code>/animals/</code> will show a page that has links for &ldquo;lion&rdquo; and &ldquo;cat&rdquo; which take visitors to the individual term pages.</p>
<p>The term pages will list all the pages contained within that term. These term lists are essentially the same as normal <a href=#list-pages>list pages</a> and behave in much the same way.</p>
<p>In order to add custom content to taxonomy pages, simply create <code>_index.md</code> files in the content folder using the taxonomy name as the sub-directory name.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell>.
└── content
└── animals
├── _index.md <span class=c1># /animals</span>
└── lion
└── _index.md <span class=c1># /animals/lion</span>
</code></pre></div><p>Anything in these content files will now be placed onto the generated taxonomy pages. As with other content, the front matter variables can be used to override defaults. In this way you could have a tag named <code>lion</code> but override the <code>title</code> to be &ldquo;Lion&rdquo;.</p>
<p>To see how this looks in reality, check out the <a href=https://jpanther.github.io/congo/tags/>tags taxonomy listing</a> on this site.</p>
<h2 id=leaf-pages class="relative group">Leaf pages <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#leaf-pages aria-label=Anchor>#</a></span></h2>
<table>
<thead>
<tr>
<th></th>
<th></th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Layout:</strong></td>
<td><code>layouts/_default/single.html</code></td>
</tr>
<tr>
<td><strong>Content (standalone):</strong></td>
<td><code>content/../page-name.md</code></td>
</tr>
<tr>
<td><strong>Content (bundled):</strong></td>
<td><code>content/../page-name/index.md</code></td>
</tr>
</tbody>
</table>
<p>Leaf pages in Hugo are basically standard content pages. They are defined as pages that don&rsquo;t contain any sub-pages. These could be things like an about page, or an individual blog post that lives in the blog section of the website.</p>
<p>The most important thing to remember about leaf pages is that unlike branch pages, leaf pages should be named <code>index.md</code> <em>without</em> an underscore. Leaf pages are also special in that they can be grouped together at the top level of the section and named with a unique name.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell>.
└── content
└── blog
├── first-post.md <span class=c1># /blog/first-post</span>
├── second-post.md <span class=c1># /blog/second-post</span>
└── third-post
├── index.md <span class=c1># /blog/third-post</span>
└── image.jpg
</code></pre></div><p>When including assets in a page, like an image, a page bundle should be used. Page bundles are created using a sub-directory with an <code>index.md</code> file. Grouping the assets with the content in its own directory is important as many of the shortcodes and other theme logic assumes that resources are bundled alongside pages.</p>
<p><strong>Example:</strong></p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-yaml data-lang=yaml><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=nt>title</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;My First Blog Post&#34;</span><span class=w>
</span><span class=w></span><span class=nt>date</span><span class=p>:</span><span class=w> </span><span class=ld>2022-01-25</span><span class=w>
</span><span class=w></span><span class=nt>description</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;Welcome to my blog!&#34;</span><span class=w>
</span><span class=w></span><span class=nt>summary</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;Learn more about me and why I am starting this blog.&#34;</span><span class=w>
</span><span class=w></span><span class=nt>tags</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=s2>&#34;welcome&#34;</span><span class=p>,</span><span class=w> </span><span class=s2>&#34;new&#34;</span><span class=p>,</span><span class=w> </span><span class=s2>&#34;about&#34;</span><span class=p>,</span><span class=w> </span><span class=s2>&#34;first&#34;</span><span class=p>]</span><span class=w>
</span><span class=w></span><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=l>_This_ is the content of my blog post.</span><span class=w>
</span></code></pre></div><p>Leaf pages have a wide variety of <a href=https://jpanther.github.io/congo/docs/front-matter/>front matter</a> parameters that can be used to customise how they are displayed.</p>
<h3 id=external-links class="relative group">External links <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#external-links aria-label=Anchor>#</a></span></h3>
<p>Congo has a special feature that allows links to external pages to appear alongside articles in the article listings. This is useful if you have content on third party websites like Medium, or research papers that you&rsquo;d like to link to, without replicating the content in your Hugo site.</p>
<p>In order to create an external link article, some special front matter needs to be set:</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-yaml data-lang=yaml><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=nt>title</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;My Medium post&#34;</span><span class=w>
</span><span class=w></span><span class=nt>date</span><span class=p>:</span><span class=w> </span><span class=ld>2022-01-25</span><span class=w>
</span><span class=w></span><span class=nt>externalUrl</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;https://medium.com/&#34;</span><span class=w>
</span><span class=w></span><span class=nt>summary</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;I wrote a post on Medium.&#34;</span><span class=w>
</span><span class=w></span><span class=nt>showReadingTime</span><span class=p>:</span><span class=w> </span><span class=kc>false</span><span class=w>
</span><span class=w></span><span class=nt>_build</span><span class=p>:</span><span class=w>
</span><span class=w> </span><span class=nt>render</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;false&#34;</span><span class=w>
</span><span class=w> </span><span class=nt>list</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;local&#34;</span><span class=w>
</span><span class=w></span><span class=nn>---</span><span class=w>
</span></code></pre></div><p>Along with the normal front matter parameters like <code>title</code> and <code>summary</code>, the <code>externalUrl</code> parameter is used to tell Congo that this is not an ordinary article. The URL provided here will be where visitors are directed when they select this article.</p>
<p>Additionally, we use a special Hugo front matter parameter <code>_build</code> to prevent a normal page for this content being generated - there&rsquo;s no point generating a page since we&rsquo;re linking to an external URL!</p>
<p>The theme includes an archetype to make generating these external link articles simple. Just specify <code>-k external</code> when making new content.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell>hugo new -k external posts/my-post.md
</code></pre></div><h2 id=custom-layouts class="relative group">Custom layouts <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#custom-layouts aria-label=Anchor>#</a></span></h2>
<p>One of the benefits of Hugo is that it makes it easy to create custom layouts for the whole site, individual sections or pages.</p>
<p>Layouts follow all the normal Hugo templating rules and more information is available in the <a href=https://gohugo.io/templates/introduction/>official Hugo docs</a>.</p>
<h3 id=overriding-default-layouts class="relative group">Overriding default layouts <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#overriding-default-layouts aria-label=Anchor>#</a></span></h3>
<p>Each of the content types discussed above lists the layout file that is used to generate each type of page. If this file is created in your local project it will override the theme template and thus can be used to customise the default style of the website.</p>
<p>For example, creating a <code>layouts/_default/single.html</code> file will allow the layout of leaf pages to be completely customised.</p>
<h3 id=custom-section-layouts class="relative group">Custom section layouts <span class="absolute top-0 w-6 transition-opacity opacity-0 ltr:-left-6 rtl:-right-6 not-prose group-hover:opacity-100"><a class="group-hover:text-primary-300 dark:group-hover:text-neutral-700" style=text-decoration-line:none!important href=#custom-section-layouts aria-label=Anchor>#</a></span></h3>
<p>It is also simple to create custom layouts for individual content sections. This is useful when you want to make a section that lists a certain type of content using a particular style.</p>
<p>Let&rsquo;s step through an example that creates a custom &ldquo;Projects&rdquo; page that lists projects using a special layout.</p>
<p>In order to do this, structure your content using the normal Hugo content rules and create a section for your projects. Additionally, create a new layout for the projects section by using the same directory name as the content and adding a <code>list.html</code> file.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-shell data-lang=shell>.
└── content
│ └── projects
│ ├── _index.md
│ ├── first-project.md
│ └── second-project.md
└── layouts
└── projects
└── list.html
</code></pre></div><p>This <code>list.html</code> file will now override the default list template, but only for the <code>projects</code> section. Before we look at this file, lets first look at the individual project files.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-yaml data-lang=yaml><span class=nn>---</span><span class=w>
</span><span class=w></span><span class=nt>title</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;Congo&#34;</span><span class=w>
</span><span class=w></span><span class=nt>date</span><span class=p>:</span><span class=w> </span><span class=ld>2021-08-11</span><span class=w>
</span><span class=w></span><span class=nt>icon</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;github&#34;</span><span class=w>
</span><span class=w></span><span class=nt>description</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;A theme for Hugo built with Tailwind CSS.&#34;</span><span class=w>
</span><span class=w></span><span class=nt>topics</span><span class=p>:</span><span class=w> </span><span class=p>[</span><span class=s2>&#34;Hugo&#34;</span><span class=p>,</span><span class=w> </span><span class=s2>&#34;Web&#34;</span><span class=p>,</span><span class=w> </span><span class=s2>&#34;Tailwind&#34;</span><span class=p>]</span><span class=w>
</span><span class=w></span><span class=nt>externalUrl</span><span class=p>:</span><span class=w> </span><span class=s2>&#34;https://github.com/jpanther/congo/&#34;</span><span class=w>
</span><span class=w></span><span class=nn>---</span><span class=w>
</span></code></pre></div><p><em>In this example we are assigning some metadata for each project that we can then use in our list template. There&rsquo;s no page content, but there&rsquo;s nothing stopping you from including it. It&rsquo;s your own custom template after all!</em></p>
<p>With the projects defined, now we can create a list template that outputs the details of each project.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-go data-lang=go><span class=p>{{</span> <span class=nx>define</span> <span class=s>&#34;main&#34;</span> <span class=p>}}</span>
<span class=p>&lt;</span><span class=nx>section</span> <span class=nx>class</span><span class=p>=</span><span class=s>&#34;mt-8&#34;</span><span class=p>&gt;</span>
<span class=p>{{</span> <span class=k>range</span> <span class=p>.</span><span class=nx>Pages</span> <span class=p>}}</span>
<span class=p>&lt;</span><span class=nx>article</span> <span class=nx>class</span><span class=p>=</span><span class=s>&#34;pb-6&#34;</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=nx>a</span> <span class=nx>class</span><span class=p>=</span><span class=s>&#34;flex&#34;</span> <span class=nx>href</span><span class=p>=</span><span class=s>&#34;{{ .Params.externalUrl }}&#34;</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=nx>div</span> <span class=nx>class</span><span class=p>=</span><span class=s>&#34;mr-3 text-3xl text-neutral-300&#34;</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=nx>span</span> <span class=nx>class</span><span class=p>=</span><span class=s>&#34;relative inline-block align-text-bottom&#34;</span><span class=p>&gt;</span>
<span class=p>{{</span> <span class=nx>partial</span> <span class=s>&#34;icon.html&#34;</span> <span class=p>.</span><span class=nx>Params</span><span class=p>.</span><span class=nx>icon</span> <span class=p>}}</span>
<span class=p>&lt;</span><span class=o>/</span><span class=nx>span</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=o>/</span><span class=nx>div</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=nx>div</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=nx>h3</span> <span class=nx>class</span><span class=p>=</span><span class=s>&#34;flex text-xl font-semibold&#34;</span><span class=p>&gt;</span>
<span class=p>{{</span> <span class=p>.</span><span class=nx>Title</span> <span class=p>}}</span>
<span class=p>&lt;</span><span class=o>/</span><span class=nx>h3</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=nx>p</span> <span class=nx>class</span><span class=p>=</span><span class=s>&#34;text-sm text-neutral-400&#34;</span><span class=p>&gt;</span>
<span class=p>{{</span> <span class=p>.</span><span class=nx>Description</span> <span class=p>}}</span>
<span class=p>&lt;</span><span class=o>/</span><span class=nx>p</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=o>/</span><span class=nx>div</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=o>/</span><span class=nx>a</span><span class=p>&gt;</span>
<span class=p>&lt;</span><span class=o>/</span><span class=nx>article</span><span class=p>&gt;</span>
<span class=p>{{</span> <span class=nx>end</span> <span class=p>}}</span>
<span class=p>&lt;</span><span class=o>/</span><span class=nx>section</span><span class=p>&gt;</span>
<span class=p>{{</span> <span class=nx>end</span> <span class=p>}}</span>
</code></pre></div><p>Although this is quite a straightforward example, you can see that it steps through each of the pages in this section (ie. each project), and then outputs HTML links to each project alongside an icon. The metadata in the front matter for each project is used to determine which information is displayed.</p>
<p>Keep in mind that you&rsquo;ll need to ensure the relevant styles and classes are available, which may require the Tailwind CSS to be recompiled. This is discussed in more detail in the <a href=https://jpanther.github.io/congo/docs/advanced-customisation/>Advanced Customisation</a> section.</p>
<p>When making custom templates like this one, it&rsquo;s always easiest to take a look at how the default Congo template works and then use that as a guide. Remember, the <a href=https://gohugo.io/templates/introduction/>Hugo docs</a> are a great resource to learn more about creating templates too.</p>
</div>
</section>
<footer class="pt-8 max-w-prose">
<div class=pt-8>
<hr class="border-dotted border-neutral-300 dark:border-neutral-600">
<div class="flex justify-between pt-3">
<span>
<a class="flex group" href=/congo/docs/partials/>
<span class="mr-3 ltr:inline rtl:hidden text-neutral-700 dark:text-neutral group-hover:text-primary-600 dark:group-hover:text-primary-400">&larr;</span>
<span class="ml-3 ltr:hidden rtl:inline text-neutral-700 dark:text-neutral group-hover:text-primary-600 dark:group-hover:text-primary-400">&rarr;</span>
<span class="flex flex-col">
<span class="mt-[0.1rem] leading-6 group-hover:underline group-hover:decoration-primary-500">Partials</span>
<span class="mt-[0.1rem] text-xs text-neutral-500 dark:text-neutral-400">
</span>
</span>
</a>
</span>
<span>
<a class="flex text-right group" href=/congo/docs/advanced-customisation/>
<span class="flex flex-col">
<span class="mt-[0.1rem] leading-6 group-hover:underline group-hover:decoration-primary-500">Advanced Customisation</span>
<span class="mt-[0.1rem] text-xs text-neutral-500 dark:text-neutral-400">
</span>
</span>
<span class="ml-3 ltr:inline rtl:hidden text-neutral-700 dark:text-neutral group-hover:text-primary-600 dark:group-hover:text-primary-400">&rarr;</span>
<span class="mr-3 ltr:hidden rtl:inline text-neutral-700 dark:text-neutral group-hover:text-primary-600 dark:group-hover:text-primary-400">&larr;</span>
</a>
</span>
</div>
</div>
</footer>
</article>
<div class="absolute top-[110vh] ltr:right-0 rtl:left-0 w-12 pointer-events-none bottom-[-5.5rem]">
<a href=#the-top class="w-12 h-12 sticky pointer-events-auto top-[calc(100vh-5rem)] bg-neutral/50 dark:bg-neutral-800/50 backdrop-blur rounded-full text-xl flex items-center justify-center text-neutral-700 dark:text-neutral hover:text-primary-600 dark:hover:text-primary-400" aria-label="Scroll to top" title="Scroll to top">
&uarr;
</a>
</div>
</main>
<div id=search-wrapper class="fixed inset-0 z-50 flex flex-col p-4 sm:p-6 md:p-[10vh] lg:p-[12vh] w-screen h-screen cursor-default bg-neutral-500/50 backdrop-blur-sm dark:bg-neutral-900/50 invisible" data-url=https://jpanther.github.io/congo/>
<div id=search-modal class="flex flex-col w-full max-w-3xl min-h-0 mx-auto border rounded-md shadow-lg border-neutral-200 top-20 bg-neutral dark:bg-neutral-800 dark:border-neutral-700">
<header class="relative z-10 flex items-center justify-between flex-none px-2">
<form class="flex items-center flex-auto min-w-0">
<div class="flex items-center justify-center w-8 h-8 text-neutral-400">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="search" class="svg-inline--fa fa-search fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentcolor" d="M505 442.7 405.3 343c-4.5-4.5-10.6-7-17-7H372c27.6-35.3 44-79.7 44-128C416 93.1 322.9.0 208 0S0 93.1.0 208s93.1 208 208 208c48.3.0 92.7-16.4 128-44v16.3c0 6.4 2.5 12.5 7 17l99.7 99.7c9.4 9.4 24.6 9.4 33.9.0l28.3-28.3c9.4-9.4 9.4-24.6.1-34zM208 336c-70.7.0-128-57.2-128-128 0-70.7 57.2-128 128-128 70.7.0 128 57.2 128 128 0 70.7-57.2 128-128 128z"/></svg>
</span>
</div>
<input type=search id=search-query class="flex flex-auto h-12 mx-1 bg-transparent appearance-none focus:outline-dotted focus:outline-transparent focus:outline-2" placeholder=Search tabindex=0>
</form>
<button id=close-search-button class="flex items-center justify-center w-8 h-8 text-neutral-700 dark:text-neutral hover:text-primary-600 dark:hover:text-primary-400" title="Close (Esc)">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="times" class="svg-inline--fa fa-times fa-w-11" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 352 512"><path fill="currentcolor" d="M242.72 256l100.07-100.07c12.28-12.28 12.28-32.19.0-44.48l-22.24-22.24c-12.28-12.28-32.19-12.28-44.48.0L176 189.28 75.93 89.21c-12.28-12.28-32.19-12.28-44.48.0L9.21 111.45c-12.28 12.28-12.28 32.19.0 44.48L109.28 256 9.21 356.07c-12.28 12.28-12.28 32.19.0 44.48l22.24 22.24c12.28 12.28 32.2 12.28 44.48.0L176 322.72l100.07 100.07c12.28 12.28 32.2 12.28 44.48.0l22.24-22.24c12.28-12.28 12.28-32.19.0-44.48L242.72 256z"/></svg>
</span>
</button>
</header>
<section class="flex-auto px-2 overflow-auto">
<ul id=search-results>
</ul>
</section>
</div>
</div>
<footer class=py-10>
<div class="flex justify-between">
<div>
<p class="text-sm text-neutral-500 dark:text-neutral-400">
© 2022 Congo contributors
</p>
<p class="text-xs text-neutral-500 dark:text-neutral-400">
Powered by <a class="hover:underline hover:decoration-primary-400 hover:text-primary-500" href=https://gohugo.io/ target=_blank rel="noopener noreferrer">Hugo</a> & <a class="hover:underline hover:decoration-primary-400 hover:text-primary-500" href=https://git.io/hugo-congo target=_blank rel="noopener noreferrer">Congo</a>
</p>
</div>
<div class="text-sm cursor-pointer text-neutral-700 dark:text-neutral hover:text-primary-600 dark:hover:text-primary-400 ltr:mr-14 rtl:ml-14">
<button id=appearance-switcher class="w-12 h-12" type=button title="Switch to dark appearance">
<span class="inline dark:hidden">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="moon" class="svg-inline--fa fa-moon fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentcolor" d="M283.211 512c78.962.0 151.079-35.925 198.857-94.792 7.068-8.708-.639-21.43-11.562-19.35-124.203 23.654-238.262-71.576-238.262-196.954.0-72.222 38.662-138.635 101.498-174.394 9.686-5.512 7.25-20.197-3.756-22.23A258.156 258.156.0 00283.211.0c-141.309.0-256 114.511-256 256 0 141.309 114.511 256 256 256z"/></svg>
</span>
</span>
<span class="hidden dark:inline">
<span class="relative inline-block align-text-bottom icon"><svg aria-hidden="true" focusable="false" data-prefix="fas" data-icon="sun" class="svg-inline--fa fa-sun fa-w-16" role="img" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path fill="currentcolor" d="M256 160c-52.9.0-96 43.1-96 96s43.1 96 96 96 96-43.1 96-96-43.1-96-96-96zm246.4 80.5-94.7-47.3 33.5-100.4c4.5-13.6-8.4-26.5-21.9-21.9l-100.4 33.5-47.4-94.8c-6.4-12.8-24.6-12.8-31 0l-47.3 94.7L92.7 70.8c-13.6-4.5-26.5 8.4-21.9 21.9l33.5 100.4-94.7 47.4c-12.8 6.4-12.8 24.6.0 31l94.7 47.3-33.5 100.5c-4.5 13.6 8.4 26.5 21.9 21.9l100.4-33.5 47.3 94.7c6.4 12.8 24.6 12.8 31 0l47.3-94.7 100.4 33.5c13.6 4.5 26.5-8.4 21.9-21.9l-33.5-100.4 94.7-47.3c13-6.5 13-24.7.2-31.1zm-155.9 106c-49.9 49.9-131.1 49.9-181 0s-49.9-131.1.0-181 131.1-49.9 181 0 49.9 131.1.0 181z"/></svg>
</span>
</span>
</button>
</div>
</div>
</footer>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink