2022-02-05 08:42:50 +00:00
<!doctype html> < html lang = en-au dir = ltr class = scroll-smooth data-default-appearance = light data-auto-appearance = true > < head >
2021-08-16 07:33:06 +00:00
< meta charset = utf-8 >
2022-02-03 00:52:04 +00:00
< meta http-equiv = content-language content = "en-au" >
2021-08-16 07:33:06 +00:00
< meta name = viewport content = "width=device-width,initial-scale=1" >
< meta http-equiv = x-ua-compatible content = "ie=edge" >
< title > Installation · Congo< / title >
< meta name = title content = "Installation · Congo" >
2022-02-03 00:52:04 +00:00
< meta name = description content = "A powerful, lightweight theme for Hugo built with Tailwind CSS." >
2021-08-19 02:53:58 +00:00
< link rel = canonical href = https://jpanther.github.io/congo/docs/installation/ >
2022-02-20 03:42:29 +00:00
< link type = text/css rel = stylesheet href = /congo/css/main.bundle.min.564bd42a5e26b676657968da510e1b5dc2e901c82ae40e09a52f34b39ed1bf23f65778b05cb2d87a4affbbc5296a3cfd0d2f6131469ff95409422e12b6bccfb4.css integrity = "sha512-VkvUKl4mtnZleWjaUQ4bXcLpAcgq5A4JpS80s57RvyP2V3iwXLLYekr/u8Upajz9DS9hMUaf+VQJQi4StrzPtA==" >
2022-02-06 22:12:37 +00:00
< script type = text/javascript src = /congo/js/appearance.min.dbca9e2200cf929a23b55442f2ff09361b8d5290147ff1407f89ed3839f0fea13db4e94f5ae6bf2f3de10d322b4bede74b578455e9cc7d5565314d914602c974.js integrity = "sha512-28qeIgDPkpojtVRC8v8JNhuNUpAUf/FAf4ntODnw/qE9tOlPWua/Lz3hDTIrS+3nS1eEVenMfVVlMU2RRgLJdA==" > < / script >
2022-02-08 23:22:34 +00:00
< script defer type = text/javascript id = script-bundle src = /congo/js/main.bundle.min.238e7ce9c541b4e7abb5781ad8e736e849e74890fcb8a26e73ea1845f573b3a0cf91418b20ac4401bdbb57d9c6c009d8f6ec50dad6d44b48f3936aea0f95c391.js integrity = "sha512-I4586cVBtOertXga2Oc26EnnSJD8uKJuc+oYRfVzs6DPkUGLIKxEAb27V9nGwAnY9uxQ2tbUS0jzk2rqD5XDkQ==" data-copy = Copy data-copied = Copied > < / script >
2021-08-26 00:19:03 +00:00
< 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 >
2021-08-16 07:33:06 +00:00
< meta property = "og:title" content = "Installation" >
< meta property = "og:description" content = "How to install the Congo theme." >
< meta property = "og:type" content = "article" >
2021-08-19 02:53:58 +00:00
< meta property = "og:url" content = "https://jpanther.github.io/congo/docs/installation/" > < meta property = "article:section" content = "docs" >
2021-08-16 07:33:06 +00:00
< meta property = "article:published_time" content = "2020-08-16T00:00:00+00:00" >
2022-02-03 00:52:04 +00:00
< meta property = "article:modified_time" content = "2020-08-16T00:00:00+00:00" > < meta property = "og:site_name" content = "Congo" >
2021-08-16 07:33:06 +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." >
2022-02-03 00:52:04 +00:00
< script type = application/ld+json > [ { "@context" : "https://schema.org" , "@type" : "Article" , "articleSection" : "Documentation" , "name" : "Installation" , "headline" : "Installation" , "description" : "How to install the Congo theme." , "abstract" : "Simply follow the standard Hugo Quick Start procedure to get up and running quickly." , "inLanguage" : "en-au" , "url" : "https:\/\/jpanther.github.io\/congo\/docs\/installation\/" , "author" : { "@type" : "Person" , "name" : "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" , "keywords" : [ "installation" , "docs" ] , "mainEntityOfPage" : "true" , "wordCount" : "976" } ] < / script >
2022-02-20 03:42:29 +00:00
< meta name = generator content = "Hugo 0.92.2" >
2021-08-16 07:33:06 +00:00
< 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 >
2022-02-03 00:52:04 +00:00
< 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" > ↓ < / 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" >
2021-08-16 07:33:06 +00:00
< div >
2022-02-20 03:42:29 +00:00
< a class = "decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" rel = me href = /congo/ > Congo< / a >
2021-08-16 07:33:06 +00:00
< / div >
< nav >
< ul class = "flex flex-col list-none sm:flex-row" >
2022-02-03 00:52:04 +00:00
< 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" >
2022-02-20 03:42:29 +00:00
< a class = "decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href = /congo/docs/ title = Documentation > Docs< / a >
2021-08-16 07:33:06 +00:00
< / li >
2022-02-03 00:52:04 +00:00
< 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" >
2022-02-20 03:42:29 +00:00
< a class = "decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href = /congo/samples/ title = "Content Samples" > Samples< / a >
2021-08-26 00:19:03 +00:00
< / li >
2022-02-03 00:52:04 +00:00
< 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" >
2022-02-20 03:42:29 +00:00
< a class = "decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href = /congo/users/ title = Users > Users< / a >
2021-08-16 07:33:06 +00:00
< / li >
2022-02-03 00:52:04 +00:00
< 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" >
2022-02-20 03:42:29 +00:00
< a class = "decoration-primary-500 hover:underline hover:decoration-2 hover:underline-offset-2" href = https://github.com/jpanther/congo title > GitHub< / a >
2022-02-03 00:52:04 +00:00
< / 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 >
2021-08-16 07:33:06 +00:00
< / li >
< / ul >
< / nav >
< / header >
2022-02-08 23:22:34 +00:00
< main id = main-content class = "relative grow" >
2022-02-03 00:52:04 +00:00
< article >
< header class = max-w-prose >
2021-12-21 02:27:30 +00:00
< ol class = "text-sm text-neutral-500 dark:text-neutral-400" >
2021-08-18 08:05:12 +00:00
< li class = "inline hidden" >
2022-02-20 03:42:29 +00:00
< a class = "hover:underline decoration-neutral-300 dark:underline-neutral-600" href = /congo/ > Welcome to Congo! :tada:< / a > < span class = "px-1 text-primary-500" > /< / span >
2021-08-18 08:05:12 +00:00
< / li >
< li class = inline >
2022-02-20 03:42:29 +00:00
< a class = "hover:underline decoration-neutral-300 dark:underline-neutral-600" href = /congo/docs/ > Documentation< / a > < span class = "px-1 text-primary-500" > /< / span >
2021-08-18 08:05:12 +00:00
< / li >
< li class = "inline hidden" >
2022-02-20 03:42:29 +00:00
< a class = "hover:underline decoration-neutral-300 dark:underline-neutral-600" href = /congo/docs/installation/ > Installation< / a > < span class = "px-1 text-primary-500" > /< / span >
2021-08-18 08:05:12 +00:00
< / li >
< / ol >
2021-12-21 02:27:30 +00:00
< h1 class = "mt-0 text-4xl font-extrabold text-neutral-900 dark:text-neutral" >
2021-08-22 07:24:36 +00:00
Installation
< / h1 >
2021-12-21 02:27:30 +00:00
< div class = "mt-8 mb-12 text-base text-neutral-500 dark:text-neutral-400" >
2022-01-24 00:53:51 +00:00
< div class = "flex flex-row flex-wrap items-center" >
2021-11-04 00:06:52 +00:00
< span title = "Reading time" > 5 mins< / span > < span class = "px-2 text-primary-500" > · < / span >
2021-08-22 07:24:36 +00:00
< span class = mb-[2px] >
2021-11-10 01:57:05 +00:00
< a href = https://github.com/jpanther/congo/tree/dev/exampleSite/content/docs/installation.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 >
2021-08-22 07:24:36 +00:00
< / span >
< / a >
2021-08-16 07:33:06 +00:00
< / span >
< / div >
2021-08-22 07:24:36 +00:00
< / div >
2021-08-16 07:33:06 +00:00
< / header >
2022-02-03 00:52:04 +00:00
< 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 = #installation > Installation< / a >
< ul >
< li > < a href = #install-hugo > Install Hugo< / a > < / li >
< li > < a href = #create-a-new-site > Create a new site< / a > < / li >
< li > < a href = #download-the-congo-theme > Download the Congo theme< / a >
< ul >
< li > < a href = #install-using-hugo > Install using Hugo< / a > < / li >
< li > < a href = #install-using-git > Install using git< / a > < / li >
< li > < a href = #install-manually > Install manually< / a > < / li >
< / ul >
< / li >
< li > < a href = #set-up-theme-configuration-files > Set up theme configuration files< / a > < / li >
< li > < a href = #next-steps > Next steps< / a > < / li >
< / ul >
< / li >
< li > < a href = #installing-updates > Installing updates< / a >
< ul >
< li > < a href = #update-using-hugo > Update using Hugo< / a > < / li >
< li > < a href = #update-using-git > Update using git< / a > < / li >
< li > < a href = #update-manually > Update manually< / a > < / li >
< / ul >
< / li >
< / ul >
< / nav >
< / div >
< / details >
< / div >
< / div >
< div class = "min-w-0 min-h-0 max-w-prose" >
2021-08-16 07:33:06 +00:00
< 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 >
2021-11-04 00:06:52 +00:00
< p > Detailed installation instructions can be found below. Instructions for < a href = #installing-updates > updating the theme< / a > are also available.< / p >
2022-02-03 00:52:04 +00:00
< h2 id = installation class = "relative group" > Installation < 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 = #installation aria-label = Anchor > #< / a > < / span > < / h2 >
2021-11-04 00:06:52 +00:00
< p > These instructions will get you up and running using Hugo and Congo from a completely blank state. Most of the dependencies mentioned in this guide can be installed using the package manager of choice for your platform.< / p >
2022-02-03 00:52:04 +00:00
< h3 id = install-hugo class = "relative group" > Install Hugo < 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 = #install-hugo aria-label = Anchor > #< / a > < / span > < / h3 >
2021-11-04 00:06:52 +00:00
< p > If you haven’ t used Hugo before, you will need to < a href = https://gohugo.io/getting-started/installing > install it onto your local machine< / a > . You can check if it’ s already installed by running the command < code > hugo version< / code > .< / p >
< div class = "flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900" >
2022-02-03 00:52:04 +00:00
< span class = "ltr:pr-3 rtl:pl-3 text-primary-400" >
2021-11-04 00:06:52 +00:00
< 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 >
2022-02-03 00:52:04 +00:00
< span class = dark:text-neutral-300 > Make sure you are using < strong > Hugo version 0.87.0< / strong > or later as the theme takes advantage of some of the latest Hugo features.< / span >
2021-11-04 00:06:52 +00:00
< / div >
< p > You can find detailed installation instructions for your platform in the < a href = https://gohugo.io/getting-started/installing > Hugo docs< / a > .< / p >
2022-02-03 00:52:04 +00:00
< h3 id = create-a-new-site class = "relative group" > Create a new site < 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 = #create-a-new-site aria-label = Anchor > #< / a > < / span > < / h3 >
2021-11-04 00:06:52 +00:00
< p > Run the command < code > hugo new site mywebsite< / code > to create a new Hugo site in a directory named < code > mywebsite< / code > .< / p >
< p > Note that you can name the project directory whatever you choose, but the instructions below will assume it’ s named < code > mywebsite< / code > . If you use a different name, be sure to substitute it accordingly.< / p >
2022-02-03 00:52:04 +00:00
< h3 id = download-the-congo-theme class = "relative group" > Download the Congo theme < 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 = #download-the-congo-theme aria-label = Anchor > #< / a > < / span > < / h3 >
2021-11-04 00:06:52 +00:00
< p > There several different ways to install the Congo theme into your Hugo website. From easiest to most difficult to install and maintain, they are:< / p >
< ul >
< li > < a href = #install-using-hugo > Hugo module< / a > (recommended)< / li >
< li > < a href = #install-using-git > Git submodule< / a > < / li >
< li > < a href = #install-manually > Manual file copy< / a > < / li >
< / ul >
< p > If you’ re unsure, choose the Hugo module method.< / p >
2022-02-03 00:52:04 +00:00
< h4 id = install-using-hugo class = "relative group" > Install using Hugo < 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 = #install-using-hugo aria-label = Anchor > #< / a > < / span > < / h4 >
2021-11-04 00:06:52 +00:00
< p > This method is the quickest and easiest for keeping the theme up-to-date. Hugo uses < strong > Go< / strong > to initialise and manage modules so you need to ensure you have < code > go< / code > installed before proceeding.< / p >
2021-08-22 07:24:36 +00:00
< ol >
< li >
< p > < a href = https://golang.org/dl/ > Download< / a > and install Go. You can check if it’ s already installed by using the command < code > go version< / code > .< / p >
2021-11-04 00:06:52 +00:00
< div class = "flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900" >
2022-02-03 00:52:04 +00:00
< span class = "ltr:pr-3 rtl:pl-3 text-primary-400" >
2021-11-04 00:06:52 +00:00
< 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 >
2022-02-03 00:52:04 +00:00
< span class = dark:text-neutral-300 > Make sure you are using < strong > Go version 1.12< / strong > or later as Hugo requires this for modules to work correctly.< / span >
2021-11-04 00:06:52 +00:00
< / div >
2021-08-22 07:24:36 +00:00
< / li >
< li >
2021-11-04 00:06:52 +00:00
< p > From your Hugo project directory (that you created above), initialise modules for your website:< / p >
2021-08-22 07:24:36 +00:00
< div class = highlight > < pre tabindex = 0 class = chroma > < code class = language-shell data-lang = shell > < span class = c1 > # If you' re managing your project on GitHub< / span >
hugo mod init github.com/< username> /< repo-name>
< span class = c1 > # If you' re managing your project locally< / span >
hugo mod init my-project
< / code > < / pre > < / div > < / li >
< li >
< p > Add the theme to your configuration by creating a new file < code > config/_default/module.toml< / code > and adding the following:< / p >
< div class = highlight > < pre tabindex = 0 class = chroma > < code class = language-toml data-lang = toml > < span class = p > [[< / span > < span class = nx > imports< / span > < span class = p > ]]< / span >
2022-02-03 05:04:08 +00:00
< span class = nx > path< / span > < span class = p > =< / span > < span class = s2 > " github.com/jpanther/congo/v2" < / span >
2021-08-22 07:24:36 +00:00
< / code > < / pre > < / div > < / li >
< li >
< p > Start your server using < code > hugo server< / code > and the theme will be downloaded automatically.< / p >
< / li >
< li >
< p > Continue to < a href = #set-up-theme-configuration-files > set up the theme configuration files< / a > .< / p >
< / li >
< / ol >
2022-02-03 00:52:04 +00:00
< h4 id = install-using-git class = "relative group" > Install using git < 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 = #install-using-git aria-label = Anchor > #< / a > < / span > < / h4 >
2021-11-04 00:06:52 +00:00
< p > For this method you’ ll need to ensure you have < strong > Git< / strong > installed on your local machine.< / p >
< p > Change into the directory for your Hugo website (that you created above), initialise a new < code > git< / code > repository and add Congo as a submodule.< / p >
2021-08-16 07:33:06 +00:00
< div class = highlight > < pre tabindex = 0 class = chroma > < code class = language-bash data-lang = bash > < span class = nb > cd< / span > mywebsite
git init
2021-08-19 02:53:58 +00:00
git submodule add -b stable https://github.com/jpanther/congo.git themes/congo
2021-11-04 00:06:52 +00:00
< / code > < / pre > < / div > < p > Then continue to < a href = #set-up-theme-configuration-files > set up the theme configuration files< / a > .< / p >
2022-02-03 00:52:04 +00:00
< h4 id = install-manually class = "relative group" > Install manually < 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 = #install-manually aria-label = Anchor > #< / a > < / span > < / h4 >
2021-08-22 07:24:36 +00:00
< ol >
< li >
< p > Download the latest release of the theme source code.< / p >
< a class = "px-4 py-2 !text-neutral !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/latest target = _blank role = button >
2021-08-18 08:05:12 +00:00
Download from Github
2021-08-22 07:24:36 +00:00
< / a >
< / li >
< li >
< p > Extract the archive, rename the folder to < code > congo< / code > and move it to the < code > themes/< / code > directory inside your Hugo project’ s root folder.< / p >
< / li >
< li >
< p > Continue to < a href = #set-up-theme-configuration-files > set up the theme configuration files< / a > .< / p >
< / li >
< / ol >
2022-02-03 00:52:04 +00:00
< h3 id = set-up-theme-configuration-files class = "relative group" > Set up theme configuration files < 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 = #set-up-theme-configuration-files aria-label = Anchor > #< / a > < / span > < / h3 >
2021-11-04 00:06:52 +00:00
< p > In the root folder of your website, delete the < code > config.toml< / code > file that was generated by Hugo. Copy the < code > *.toml< / code > config files from the theme into your < code > config/_default/< / code > folder. This will ensure you have all the correct theme settings and will enable you to easily customise the theme to your needs.< / p >
< div class = "flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900" >
2022-02-03 00:52:04 +00:00
< span class = "ltr:pr-3 rtl:pl-3 text-primary-400" >
2021-11-04 00:06:52 +00:00
< 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 >
2022-02-03 00:52:04 +00:00
< span class = dark:text-neutral-300 > < strong > Note:< / strong > You should not overwrite the < code > module.toml< / code > file if one already exists in your project!< / span >
2021-11-04 00:06:52 +00:00
< / div >
2021-08-22 07:24:36 +00:00
< p > Depending on how you installed the theme you will find the theme config files in different places:< / p >
< ul >
< li > < strong > Hugo Modules:< / strong > In the Hugo cache directory, or < a href = "https://minhaskamal.github.io/DownGit/#/home?url=https://github.com/jpanther/congo/tree/stable/config/_default" > download a copy< / a > from GitHub< / li >
< li > < strong > Git submodule or Manual install:< / strong > < code > themes/congo/config/_default< / code > < / li >
< / ul >
< p > Once you’ ve copied the files, your config folder should look like this:< / p >
< div class = highlight > < pre tabindex = 0 class = chroma > < code class = language-shell data-lang = shell > config/_default/
├─ config.toml
├─ markup.toml
├─ menus.toml
├─ module.toml < span class = c1 > # if you installed using Hugo Modules< / span >
└─ params.toml
< / code > < / pre > < / div > < div class = "flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900" >
2022-02-03 00:52:04 +00:00
< span class = "ltr:pr-3 rtl:pl-3 text-primary-400" >
2021-08-16 07:33:06 +00:00
< 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 >
2022-02-03 00:52:04 +00:00
< span class = dark:text-neutral-300 > < strong > Important:< / strong > If you didn’ t use Hugo Modules to install Congo, you must add the line < code > theme = "congo"< / code > to the top of your < code > config.toml< / code > file.< / span >
2021-08-16 07:33:06 +00:00
< / div >
2022-02-03 00:52:04 +00:00
< h3 id = next-steps class = "relative group" > Next steps < 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 = #next-steps aria-label = Anchor > #< / a > < / span > < / h3 >
2021-11-04 00:06:52 +00:00
< p > The basic Congo installation is now complete. Continue to the < a href = https://jpanther.github.io/congo/docs/getting-started/ > Getting Started< / a > section to learn more about configuring the theme.< / p >
< hr >
2022-02-03 00:52:04 +00:00
< h2 id = installing-updates class = "relative group" > Installing updates < 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 = #installing-updates aria-label = Anchor > #< / a > < / span > < / h2 >
2021-11-04 00:06:52 +00:00
< p > From time to time there will be < a href = https://github.com/jpanther/congo/releases > new releases< / a > posted that apply fixes and add new functionality to the theme. In order to take advantage of these changes, you will need to update the theme files on your website.< / p >
< p > How you go about this will depend on the installation method you chose when the theme was originally installed. Instructions for each method can be found below.< / p >
< ul >
< li > < a href = #update-using-hugo > Hugo module< / a > < / li >
< li > < a href = #update-using-git > Git submodule< / a > < / li >
< li > < a href = #update-manually > Manual file copy< / a > < / li >
< / ul >
2022-02-03 00:52:04 +00:00
< h3 id = update-using-hugo class = "relative group" > Update using Hugo < 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 = #update-using-hugo aria-label = Anchor > #< / a > < / span > < / h3 >
2021-11-04 00:06:52 +00:00
< p > Hugo makes updating modules super easy. Simply change into your project directory and execute the following command:< / p >
< div class = highlight > < pre tabindex = 0 class = chroma > < code class = language-shell data-lang = shell > hugo mod get -u
< / code > < / pre > < / div > < p > Hugo will automatically update any modules that are required for your project. It does this by inspecting your < code > module.toml< / code > and < code > go.mod< / code > files. If you have any issues with the update, check to ensure these files are still configured correctly.< / p >
< p > Then simply rebuild your site and check everything works as expected.< / p >
2022-02-03 00:52:04 +00:00
< h3 id = update-using-git class = "relative group" > Update using git < 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 = #update-using-git aria-label = Anchor > #< / a > < / span > < / h3 >
2021-11-04 00:06:52 +00:00
< p > Git submodules can be updated using the < code > git< / code > command. Simply execute the following command and the latest version of the theme will be downloaded into your local repository:< / p >
< div class = highlight > < pre tabindex = 0 class = chroma > < code class = language-shell data-lang = shell > git submodule update --remote --merge
< / code > < / pre > < / div > < p > Once the submodule has been updated, rebuild your site and check everything works as expected.< / p >
2022-02-03 00:52:04 +00:00
< h3 id = update-manually class = "relative group" > Update manually < 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 = #update-manually aria-label = Anchor > #< / a > < / span > < / h3 >
2021-11-04 00:06:52 +00:00
< p > Updating Congo manually requires you to download the latest copy of the theme and replace the old version in your project.< / p >
< div class = "flex px-4 py-3 rounded-md bg-primary-100 dark:bg-primary-900" >
2022-02-03 00:52:04 +00:00
< span class = "ltr:pr-3 rtl:pl-3 text-primary-400" >
2021-11-04 00:06:52 +00:00
< 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 >
2022-02-03 00:52:04 +00:00
< span class = dark:text-neutral-300 > Note that any local customisations you have made to the theme files will be lost during this process.< / span >
2021-11-04 00:06:52 +00:00
< / div >
< ol >
< li >
< p > Download the latest release of the theme source code.< / p >
< a class = "px-4 py-2 !text-neutral !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/latest target = _blank role = button >
Download from Github
< / a >
< / li >
< li >
< p > Extract the archive, rename the folder to < code > congo< / code > and move it to the < code > themes/< / code > directory inside your Hugo project’ s root folder. You will need to overwrite the existing directory to replace all the theme files.< / p >
< / li >
< li >
< p > Rebuild your site and check everything works as expected.< / p >
< / li >
< / ol >
2022-02-03 00:52:04 +00:00
< / div >
2021-08-16 07:33:06 +00:00
< / section >
2022-02-03 00:52:04 +00:00
< footer class = "pt-8 max-w-prose" >
< div class = pt-8 >
2021-08-22 07:24:36 +00:00
< hr class = "border-dotted border-neutral-300 dark:border-neutral-600" >
2021-08-16 07:33:06 +00:00
< div class = "flex justify-between pt-3" >
< span >
< / span >
< span >
2022-02-03 00:52:04 +00:00
< a class = "flex text-right group" href = /congo/docs/getting-started/ >
2021-08-16 07:33:06 +00:00
< span class = "flex flex-col" >
2022-02-03 00:52:04 +00:00
< span class = "mt-[0.1rem] leading-6 group-hover:underline group-hover:decoration-primary-500" > Getting Started< / span >
2021-12-21 02:27:30 +00:00
< span class = "mt-[0.1rem] text-xs text-neutral-500 dark:text-neutral-400" >
2021-08-22 07:24:36 +00:00
< / span >
2021-08-16 07:33:06 +00:00
< / span >
2022-02-03 00:52:04 +00:00
< 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" > → < / 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" > ← < / span >
2021-08-16 07:33:06 +00:00
< / a >
< / span >
< / div >
< / div >
< / footer >
< / article >
2022-02-03 00:52:04 +00:00
< 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" >
↑
< / 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 >
2021-11-04 00:06:52 +00:00
< div class = "flex justify-between" >
< div >
2021-12-21 02:27:30 +00:00
< p class = "text-sm text-neutral-500 dark:text-neutral-400" >
2022-02-03 00:52:04 +00:00
© 2022 Congo contributors
2021-08-16 07:33:06 +00:00
< / p >
2022-02-03 00:52:04 +00:00
< 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 >
2021-08-16 07:33:06 +00:00
< / p >
2021-11-04 00:06:52 +00:00
< / div >
2022-02-03 00:52:04 +00:00
< 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 >
2021-11-04 00:06:52 +00:00
< / div >
2021-08-16 07:33:06 +00:00
< / footer >
< / body >
< / html >
