mirror of https://github.com/jpanther/congo.git
155 lines
11 KiB
HTML
155 lines
11 KiB
HTML
<!doctype html><html lang=en-au><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>Getting Started · Congo</title>
|
|
<meta name=title content="Getting Started · Congo">
|
|
<meta name=description content="All the front matter variables available in Congo.">
|
|
<link rel=canonical href=https://jpanther.github.io/Congo/docs/getting-started/>
|
|
<link type=text/css rel=stylesheet href=https://jpanther.github.io/Congo/css/main.css>
|
|
<link rel=apple-touch-icon sizes=180x180 href=https://jpanther.github.io/Congo/apple-touch-icon.png>
|
|
<link rel=icon type=image/png sizes=32x32 href=https://jpanther.github.io/Congo/favicon-32x32.png>
|
|
<link rel=icon type=image/png sizes=16x16 href=https://jpanther.github.io/Congo/favicon-16x16.png>
|
|
<link rel=manifest href=https://jpanther.github.io/Congo/site.webmanifest>
|
|
<meta property="og:title" content="Getting Started">
|
|
<meta property="og:description" content="All the front matter variables available in Congo.">
|
|
<meta property="og:type" content="article">
|
|
<meta property="og:url" content="https://jpanther.github.io/Congo/docs/getting-started/"><meta property="article:section" content="docs">
|
|
<meta property="article:published_time" content="2020-08-15T00:00:00+00:00">
|
|
<meta property="article:modified_time" content="2020-08-15T00:00:00+00:00">
|
|
<meta name=twitter:card content="summary">
|
|
<meta name=twitter:title content="Getting Started">
|
|
<meta name=twitter:description content="All the front matter variables available in Congo.">
|
|
<script type=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","articleSection":"Documentation","name":"Getting Started","headline":"Getting Started","description":"All the front matter variables available in Congo.","inLanguage":"en-AU","author":{"@type":"Person","name":"Congo"},"creator":{"@type":"Person","name":"Congo"},"copyrightHolder":"Congo","copyrightYear":"2020","dateCreated":"2020-08-15T00:00:00\u002b00:00","datePublished":"2020-08-15T00:00:00\u002b00:00","dateModified":"2020-08-15T00:00:00\u002b00:00","url":"https:\/\/jpanther.github.io\/Congo\/docs\/getting-started\/","wordCount":"338","keywords":["installation","docs"]}</script>
|
|
<meta name=generator content="Hugo 0.87.0">
|
|
<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-white text-grey-900 sm:px-14 md:px-24 lg:px-32 dark:bg-gray-800 dark:text-white max-w-7xl"><header class="flex justify-between py-6 font-semibold sm:py-10">
|
|
<div>
|
|
<a class="hover:underline underline-primary-500 underline-thickness-bold underline-offset-small" rel=me href=https://jpanther.github.io/Congo/>Congo</a>
|
|
</div>
|
|
<nav>
|
|
<ul class="flex flex-col list-none sm:flex-row">
|
|
<li class="text-right sm:mr-7 sm:last:mr-0">
|
|
<a class="hover:underline underline-primary-500 underline-thickness-bold underline-offset-small" href=https://jpanther.github.io/Congo/docs/ title=Documentation>Docs</a>
|
|
</li>
|
|
<li class="text-right sm:mr-7 sm:last:mr-0">
|
|
<a class="hover:underline underline-primary-500 underline-thickness-bold underline-offset-small" href=https://jpanther.github.io/Congo/samples/ title="Content Samples">Samples</a>
|
|
</li>
|
|
<li class="text-right sm:mr-7 sm:last:mr-0">
|
|
<a class="hover:underline underline-primary-500 underline-thickness-bold underline-offset-small" href=https://github.com/jpanther/Congo title>GitHub</a>
|
|
</li>
|
|
</ul>
|
|
</nav>
|
|
</header>
|
|
<main class=flex-grow>
|
|
<article class=max-w-prose>
|
|
<header>
|
|
<ol class="text-sm text-gray-400 dark:text-gray-500">
|
|
<li class="inline hidden">
|
|
<a class="hover:underline underline-gray-300 dark:underline-gray-600" href=https://jpanther.github.io/Congo/>Welcome to Congo! :tada:</a><span class="px-1 text-primary-500">/</span>
|
|
</li>
|
|
<li class=inline>
|
|
<a class="hover:underline underline-gray-300 dark:underline-gray-600" href=https://jpanther.github.io/Congo/docs/>Documentation</a><span class="px-1 text-primary-500">/</span>
|
|
</li>
|
|
<li class="inline hidden">
|
|
<a class="hover:underline underline-gray-300 dark:underline-gray-600" href=https://jpanther.github.io/Congo/docs/getting-started/>Getting Started</a><span class="px-1 text-primary-500">/</span>
|
|
</li>
|
|
</ol>
|
|
<h1 class="mt-0 text-4xl font-extrabold">Getting Started</h1>
|
|
<div class="mt-8 mb-12 text-base text-gray-400 dark:text-gray-500">
|
|
<span title="Reading time">
|
|
2 mins
|
|
</span>
|
|
</div>
|
|
</header>
|
|
<section class="prose dark:prose-light">
|
|
<div class="flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900">
|
|
<span class="pr-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="no-prose dark:text-gray-300">This section assumes you have already <a href=../../docs/installation/>installed the Congo theme</a>.</span>
|
|
</div>
|
|
<p>The config files that ship with Congo contain all of the possible settings that the theme recognises. By default, many of these are commented out but you can simply uncomment them to activate or change a specific feature.</p>
|
|
<p>A few things you need to set for a new installation:</p>
|
|
<div class=highlight><pre tabindex=0 class=chroma><code class=language-toml data-lang=toml><span class=c># config/_default/config.toml</span>
|
|
|
|
<span class=nx>baseURL</span> <span class=p>=</span> <span class=s2>"https://your_domain.com"</span>
|
|
<span class=nx>languageCode</span> <span class=p>=</span> <span class=s2>"en-AU"</span>
|
|
<span class=nx>title</span> <span class=p>=</span> <span class=s2>"My awesome website"</span>
|
|
|
|
<span class=p>[</span><span class=nx>author</span><span class=p>]</span>
|
|
<span class=nx>name</span> <span class=p>=</span> <span class=s2>"Your name"</span>
|
|
<span class=nx>image</span> <span class=p>=</span> <span class=s2>"img/author.jpg"</span>
|
|
<span class=nx>links</span> <span class=p>=</span> <span class=p>[</span>
|
|
<span class=p>{</span> <span class=nx>twitter</span> <span class=p>=</span> <span class=s2>"https://twitter.com/username"</span> <span class=p>}</span>
|
|
<span class=p>]</span>
|
|
</code></pre></div><p>The <code>[author]</code> configuration determines how the author information is displayed on the website. The image should be placed in the site’s <code>static/</code> folder. Links will be displayed in the order they are listed.</p>
|
|
<p>Further detail about these configuration options is covered in the <a href=../../docs/configuration/>Configuration</a> section.</p>
|
|
<h2 id=organising-content>Organising content <a class=heading-anchor href=#organising-content aria-label=Anchor>#</a></h2>
|
|
<p>By default, Congo doesn’t force you to use a particular content type. In doing so you are free to define your content as you wish. You might prefer <em>pages</em> for a static site, <em>posts</em> for a blog, or <em>projects</em> for a portfolio.</p>
|
|
<p>The same logic applies to taxonomies. Some people prefer to use <em>tags</em> and <em>categories</em>, others prefer to use <em>topics</em>.</p>
|
|
<p>Hugo defaults to using posts, tags and categories out of the box and this will work fine if that’s what you want. If you wish to customise this, however, you can do so by creating the following files:</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>topic</span> <span class=p>=</span> <span class=s2>"topics"</span>
|
|
</code></pre></div><p>This will replace the default <em>tags</em> and <em>categories</em> with <em>topics</em>. Refer to the <a href=https://gohugo.io/content-management/taxonomies/>Hugo Taxonomy docs</a> for more information on naming taxonomies.</p>
|
|
<p>When you create a new taxonomy, you will need to adjust the navigation links on the website to point to the new sections:</p>
|
|
<div class=highlight><pre tabindex=0 class=chroma><code class=language-toml data-lang=toml><span class=c># config/_default/menus.toml</span>
|
|
|
|
<span class=p>[[</span><span class=nx>main</span><span class=p>]]</span>
|
|
<span class=nx>name</span> <span class=p>=</span> <span class=s2>"Blog"</span>
|
|
<span class=nx>pageRef</span> <span class=p>=</span> <span class=s2>"posts"</span>
|
|
<span class=nx>weight</span> <span class=p>=</span> <span class=mi>10</span>
|
|
|
|
<span class=p>[[</span><span class=nx>main</span><span class=p>]]</span>
|
|
<span class=nx>name</span> <span class=p>=</span> <span class=s2>"Topics"</span>
|
|
<span class=nx>pageRef</span> <span class=p>=</span> <span class=s2>"topics"</span>
|
|
<span class=nx>weight</span> <span class=p>=</span> <span class=mi>20</span>
|
|
</code></pre></div><p>These steps are the bare minimum configuration. If you now run <code>hugo server</code> you will be presented with a blank Congo website. Detailed configuration is covered in the <a href=../../docs/configuration/>Configuration</a> section.</p>
|
|
</section>
|
|
<footer class=pt-8>
|
|
<div class="pt-8 article-pagination">
|
|
<hr class="border-gray-300 border-dotted dark:border-gray-600">
|
|
<div class="flex justify-between pt-3">
|
|
<span>
|
|
<a class=flex href=https://jpanther.github.io/Congo/docs/installation/>
|
|
<span class="mr-3 article-pagination-direction">←</span>
|
|
<span class="flex flex-col">
|
|
<span class=article-pagination-title>Installation</span>
|
|
</span>
|
|
</a>
|
|
</span>
|
|
<span>
|
|
<a class="flex text-right" href=https://jpanther.github.io/Congo/docs/configuration/>
|
|
<span class="flex flex-col">
|
|
<span class=article-pagination-title>Configuration</span>
|
|
</span>
|
|
<span class="ml-3 article-pagination-direction">→</span>
|
|
</a>
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
</article>
|
|
</main><footer class="py-10 text-sm">
|
|
<p class="text-gray-400 dark:text-gray-500">
|
|
©
|
|
2021
|
|
Congo
|
|
</p>
|
|
<p class="text-xs text-gray-300 dark:text-gray-600">
|
|
Powered by
|
|
<a class="hover:underline underline-primary-300 hover:text-primary-400" href=https://gohugo.io/ target=_blank>Hugo</a>
|
|
&
|
|
<a class="hover:underline underline-primary-300 hover:text-primary-400" href=https://git.io/hugo-congo target=_blank>Congo</a>
|
|
</p>
|
|
</footer>
|
|
</body>
|
|
</html> |