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

143 lines
10 KiB
HTML
Raw Blame History

<!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>Installation &#183; Congo</title>
<meta name=title content="Installation &#183; Congo">
<meta name=description content="How to install the Congo theme.">
<link rel=canonical href=https://jpanther.github.io/Congo/docs/installation/>
<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="Installation">
<meta property="og:description" content="How to install the Congo theme.">
<meta property="og:type" content="article">
<meta property="og:url" content="https://jpanther.github.io/Congo/docs/installation/"><meta property="article:section" content="docs">
<meta property="article:published_time" content="2020-08-16T00:00:00+00:00">
<meta property="article:modified_time" content="2020-08-16T00:00:00+00:00">
<meta name=twitter:card content="summary">
<meta name=twitter:title content="Installation">
<meta name=twitter:description content="How to install the Congo theme.">
<script type=application/ld+json>{"@context":"https://schema.org","@type":"BlogPosting","articleSection":"Documentation","name":"Installation","headline":"Installation","description":"How to install the Congo theme.","inLanguage":"en-AU","author":{"@type":"Person","name":"Congo"},"creator":{"@type":"Person","name":"Congo"},"copyrightHolder":"Congo","copyrightYear":"2020","dateCreated":"2020-08-16T00:00:00\u002b00:00","datePublished":"2020-08-16T00:00:00\u002b00:00","dateModified":"2020-08-16T00:00:00\u002b00:00","url":"https:\/\/jpanther.github.io\/Congo\/docs\/installation\/","wordCount":"318","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/installation/>Installation</a><span class="px-1 text-primary-500">/</span>
</li>
</ol>
<h1 class="mt-0 text-4xl font-extrabold">Installation</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">
<p>Simply follow the standard Hugo <a href=https://gohugo.io/getting-started/quick-start/>Quick Start</a> procedure to get up and running quickly.</p>
<p>Detailed instructions can be found below.</p>
<h2 id=install-hugo>Install Hugo <a class=heading-anchor href=#install-hugo aria-label=Anchor>#</a></h2>
<p>You can find specific instructions for your platform in the official <a href=https://gohugo.io/getting-started/installing.>Hugo docs</a>.</p>
<p>Make sure you are using <strong>Hugo version 0.86.1</strong> or later as the theme takes advantage of some of the latest Hugo features.</p>
<h2 id=create-a-new-site>Create a new site <a class=heading-anchor href=#create-a-new-site aria-label=Anchor>#</a></h2>
<p>Run the command <code>hugo new site mywebsite</code> to create a new Hugo site in a folder named <code>mywebsite</code>.</p>
<h2 id=download-the-congo-theme>Download the Congo theme <a class=heading-anchor href=#download-the-congo-theme aria-label=Anchor>#</a></h2>
<p>There are a couple of ways to install the Congo theme into your Hugo website. The git method is the easiest to keep the theme up-to-date, but you can also download and install manually if you don&rsquo;t have git available.</p>
<h3 id=install-using-git>Install using git <a class=heading-anchor href=#install-using-git aria-label=Anchor>#</a></h3>
<p>Change into the directory for your Hugo website, initialise a new repository and add Congo as a submodule.</p>
<div class=highlight><pre tabindex=0 class=chroma><code class=language-bash data-lang=bash><span class=nb>cd</span> mywebsite
git init
git submodule add -b stable https://github.com/jpanther/Congo.git themes/congo
</code></pre></div><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"><strong>Note:</strong> You need to substitute <code>mywebsite</code> for the correct folder name you used in Step 2.</span>
</div>
<h3 id=install-manually>Install manually <a class=heading-anchor href=#install-manually aria-label=Anchor>#</a></h3>
<p>Download the latest release of the theme.</p>
<button class="px-4 py-1 !text-white !no-underline rounded-md bg-primary-600 hover:!bg-primary-500 dark:bg-primary-800 dark:hover:!bg-primary-700" href=https://github.com/jpanther/Congo/releases target=_blank role=button>
Download from Github
</button>
<p>Extract the archive, rename the folder to <code>congo</code> and move it to the <code>themes/</code> directory inside your your <code>mywebsite</code> folder.</p>
<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"><strong>Note:</strong> You need to substitute <code>mywebsite</code> for the correct folder name you used in Step 2.</span>
</div>
<h2 id=set-up-your-configuration-files>Set up your configuration files <a class=heading-anchor href=#set-up-your-configuration-files aria-label=Anchor>#</a></h2>
<p>In the root folder of your website, delete the <code>config.toml</code> file that was generated by Hugo. Copy the entire <code>config</code> folder from <code>themes/congo/config/</code> into the root of your website. This will ensure you have all the correct theme settings and will enable you to easily customise the theme.</p>
<p>You&rsquo;re now all set up to use Congo. From here you can add some content and start the Hugo server.</p>
<p>Refer to the Hugo docs for more information or read the next section to learn more about configuring the theme.</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>
</span>
<span>
<a class="flex text-right" href=https://jpanther.github.io/Congo/docs/getting-started/>
<span class="flex flex-col">
<span class=article-pagination-title>Getting Started</span>
</span>
<span class="ml-3 article-pagination-direction">&rarr;</span>
</a>
</span>
</div>
</div>
</footer>
</article>
</main><footer class="py-10 text-sm">
<p class="text-gray-400 dark:text-gray-500">
&copy;
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>
Reference in New Issue View Git Blame Copy Permalink