Written in Go, Hugo is an open source static site generator available under the Apache Licence 2.0. Hugo supports TOML, YAML and JSON data file types, Markdown and HTML content files and uses shortcodes to add rich content. Other notable features are taxonomies, multilingual mode, image processing, custom output formats, HTML/CSS/JS minification and support for Sass SCSS workflows.
-
Hugo makes use of a variety of open source projects including:
Hugo is ideal for blogs, corporate websites, creative portfolios, online magazines, single page applications or even a website with thousands of pages.
-
Hugo is for people who want to hand code their own website without worrying about setting up complicated runtimes, dependencies and databases.
-
Websites built with Hugo are extremely fast, secure and can be deployed anywhere including, AWS, GitHub Pages, Heroku, Netlify and any other hosting provider.
To enable emoji globally, set enableEmoji to true in your site’s configuration and then you can type emoji shorthand codes directly in content files; e.g.
-
The Emoji cheat sheet is a useful reference for emoji shorthand codes.
-
-
N.B. The above steps enable Unicode Standard emoji characters and sequences in Hugo, however the rendering of these glyphs depends on the browser and the platform. To style the emoji you can either use a third party emoji font or a font stack; e.g.
-
.emoji {
-font-family: Apple Color Emoji, Segoe UI Emoji, NotoColorEmoji, Segoe UI Symbol, Android Emoji, EmojiSymbols;
-}
-
-
-
-
-
-
\ No newline at end of file
diff --git a/blog/index.xml b/blog/index.xml
deleted file mode 100644
index 4a2d0484..00000000
--- a/blog/index.xml
+++ /dev/null
@@ -1,2 +0,0 @@
-Blog on Congohttps://jpanther.github.io/Congo/blog/Recent content in Blog on CongoHugo -- gohugo.ioen-AUMon, 11 Mar 2019 00:00:00 +0000Markdown Syntax Guidehttps://jpanther.github.io/Congo/blog/markdown-syntax/Mon, 11 Mar 2019 00:00:00 +0000https://jpanther.github.io/Congo/blog/markdown-syntax/<p>This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.</p>Rich Contenthttps://jpanther.github.io/Congo/blog/rich-content/Sun, 10 Mar 2019 00:00:00 +0000https://jpanther.github.io/Congo/blog/rich-content/<p>Hugo ships with several <a href="https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes">Built-in Shortcodes</a> for rich content, along with a <a href="https://gohugo.io/about/hugo-and-gdpr/">Privacy Config</a> and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds.</p>
-<h2 id="heading"></h2>Placeholder Texthttps://jpanther.github.io/Congo/blog/placeholder-text/Sat, 09 Mar 2019 00:00:00 +0000https://jpanther.github.io/Congo/blog/placeholder-text/<p>Lorem est tota propiore conpellat pectoribus de pectora summo.</p>Math Typesettinghttps://jpanther.github.io/Congo/blog/math-typesetting/Fri, 08 Mar 2019 00:00:00 +0000https://jpanther.github.io/Congo/blog/math-typesetting/<p>Mathematical notation in a Hugo project can be enabled by using third party JavaScript libraries.</p>Emoji Supporthttps://jpanther.github.io/Congo/blog/emoji-support/Tue, 05 Mar 2019 00:00:00 +0000https://jpanther.github.io/Congo/blog/emoji-support/<p>Emoji can be enabled in a Hugo project in a number of ways.</p>
\ No newline at end of file
diff --git a/blog/markdown-syntax/index.html b/blog/markdown-syntax/index.html
deleted file mode 100644
index cedfb4c0..00000000
--- a/blog/markdown-syntax/index.html
+++ /dev/null
@@ -1,242 +0,0 @@
-
-
-
-
-
-Markdown Syntax Guide · Congo
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.
Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
-
Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations.
Lorem est tota propiore conpellat pectoribus de pectora summo.
-
Redit teque digerit hominumque toris verebor lumina non cervice subde tollit usus habet Arctonque, furores quas nec ferunt. Quoque montibus nunc caluere tempus inhospita parcite confusaque translucet patri vestro qui optatis lumine cognoscere flos nubis! Fronde ipsamque patulos Dryopen deorum.
-
-
Exierant elisi ambit vivere dedere
-
Duce pollice
-
Eris modo
-
Spargitque ferrea quos palude
-
-
Rursus nulli murmur; hastile inridet ut ab gravi sententia! Nomine potitus silentia flumen, sustinet placuit petis in dilapsa erat sunt. Atria tractus malis.
Victa caducifer, malo vulnere contra dicere aurato, ludit regale, voca! Retorsit colit est profanae esse virescere furit nec; iaculi matertera et visa est, viribus. Divesque creatis, tecta novat collumque vulnus est, parvas. Faces illo pepulere tempus adest. Tendit flamma, ab opes virum sustinet, sidus sequendo urbis.
-
Iubar proles corpore raptos vero auctor imperium; sed et huic: manus caeli Lelegas tu lux. Verbis obstitit intus oblectamina fixis linguisque ausus sperare Echionides cornuaque tenent clausit possit. Omnia putatur. Praeteritae refert ausus; ferebant e primus lora nutat, vici quae mea ipse. Et iter nil spectatae vulnus haerentia iuste et exercebat, sui et.
-
Eurytus Hector, materna ipsumque ut Politen, nec, nate, ignari, vernum cohaesit sequitur. Vel mitis temploque vocatus, inque alis, oculos nomen non silvis corpore coniunx ne displicet illa. Crescunt non unus, vidit visa quantum inmiti flumina mortis facto sic: undique a alios vincula sunt iactata abdita! Suspenderat ego fuit tendit: luna, ante urbem Propoetides parte.
Hugo ships with several Built-in Shortcodes for rich content, along with a Privacy Config and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds.
“In addition to being more logical, asymmetry has the advantage that its complete appearance is far more optically effective than symmetry.” — Jan Tschichold pic.twitter.com/gcv7SrhvJb
There are a couple of ways you can make style changes to Congo.
+
If you just need to add or override some simple styles, you can do so by creating a custom.css file in your project’s static/css/ folder. This file will be loaded automatically after the theme’s default styles.
+
Alternatively, if you’d like to make a major change, you can take advantage of Tailwind CSS’s JIT compiler and rebuild the entire theme CSS from scratch.
+
+
+
+
+
+Note: Building the theme manually is intended for advanced users.
+
+
Change into the themes/congo/ folder and install the project dependencies.
+
npm install
+
Once installed, you can edit the themes/congo/tailwind.config.js to change the styles that are applied throughout the theme. You can also adjust specific styles in themes/congo/assets/css/main.css.
+
To allow for easy theme colour changes, Congo defines a primary and secondary colour palette that is used throughout the theme. In order to change the colour across the entire theme, simply edit the tailwind.config.js file accordingly.
+
For example, to change to a green colour scheme, you could apply these changes:
For a full list of colours available, and their corresponding configuration values, see the official Tailwind docs.
+
After editing the configuration, you need to rebuild the theme’s stylesheets.
+
npm run build
+
This will automatically output a minified CSS file to /themes/congo/static/css/main.css.
+
To aid with testing style changes, you can also run the Tailwind JIT comiler in watch mode.
+
npm run dev
+
Now whenever you make a change, the (non-minified) CSS files will be rebuilt automatically. This mode is useful to run when using hugo server to preview your site during development. Remember to perform a full build before publishing your website.
Congo is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured.
+
The theme ships with a default configuration that gets you up and running with a basic blog or static website.
+
+
Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON if you wish.
+
+
The default theme configuration is documented in each file so you can freely adjust the settings to meet your needs.
+
+
+
+
+
+As outlined in the installation instructions, you should adjust your theme configuration by modifying the files in the config/_default/ folder of your Hugo project and delete the config.toml file in your project root.
+
Congo provides a large number of configuration parameters that control how the theme functions. The table below outlines every available parameter in the config/_default/params.toml file.
+
Many of the article defaults here can be overridden on a per article basis by specifying it in the front matter. Refer to the Front Matter section for further details.
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
homepage.layout
+
string
+
"page"
+
The layout of the homepage. Valid values are page, profile or custom. When set to custom, you must provide your own layout by creating a /layouts/partials/home/custom.html file. Refer to the Homepage Layout section for more details.
+
+
+
homepage.showList
+
boolean
+
false
+
Whether or not recent articles are listed on the homepage beneath the page content. Refer to the Recent Articles docs for more details.
+
+
+
homepage.listSections
+
array of strings
+
["blog"]
+
The sections of content to include in the recent list when homepage.showList is true.
+
+
+
article.showDate
+
boolean
+
true
+
Whether or not article dates are displayed.
+
+
+
article.dateFormat
+
string
+
"2 January 2006"
+
How article dates are formatted. Refer to the Hugo docs for acceptable formats.
+
+
+
article.showAuthor
+
boolean
+
true
+
Whether or not the author box is displayed in the article footer.
+
+
+
article.showDraftLabel
+
boolean
+
true
+
Whether or not the draft indicator is shown next to articles when site is built with --buildDrafts.
+
+
+
article.showHeadingAnchors
+
boolean
+
true
+
Whether or not heading anchor links are displayed alongside headings within articles.
+
+
+
article.showPagination
+
boolean
+
true
+
Whether or not the next/previous article links are displayed in the article footer.
+
+
+
article.showReadingTime
+
boolean
+
true
+
Whether or not article reading times are displayed.
+
+
+
article.sharingLinks
+
array of strings
+
Not set
+
Which sharing links to display at the end of each article. When not provided, or set to false no links will be displayed.
+
+
+
list.groupByYear
+
boolean
+
true
+
Whether or not articles are grouped under years in the article listing.
+
+
+
sitemap.excludedKinds
+
array of strings
+
["taxonomy", "term"]
+
Kinds of content that should be excluded from the generated /sitemap.xml file. Refer to the Hugo docs for acceptable values.
+
+
+
taxonomy.showTermCount
+
boolean
+
true
+
Whether or not the number of articles within a taxonomy term is displayed on the taxonomy listing.
+
+
+
fathomAnalytics.site
+
string
+
Not set
+
The site code generated by Fathom Analytics for the website. Refer to the Analytics docs below for more details.
+
+
+
fathomAnalytics.domain
+
string
+
Not set
+
If using a custom domain with Fathom Analytics, provide it here to serve script.js from the custom domain.
+
+
+
verification.google
+
string
+
Not set
+
The site verification string provided by Google to be included in the site metadata.
+
+
+
verification.bing
+
string
+
Not set
+
The site verification string provided by Bing to be included in the site metadata.
+
+
+
verification.pinterest
+
string
+
Not set
+
The site verification string provided by Pinterest to be included in the site metadata.
+
+
+
verification.yandex
+
string
+
Not set
+
The site verification string provided by Yandex to be included in the site metadata.
In addition to the default Hugo front matter parameters, Congo adds a number of additional options to customise the presentation of individual articles. All the available theme parameters are listed below.
+
Front matter parameter default values are inherited from the theme’s base configuration, so you only need to specify these parameters in your front matter when you want to override the default.
+
+
+
+
Name
+
Type
+
Default
+
Description
+
+
+
+
+
externalUrl
+
string
+
Not set
+
If this article is published on a third-party website, the URL to this article. Providing a URL will prevent a content page being generated and any references to this article will link directly to the third-party website.
+
+
+
showDate
+
boolean
+
article.showDate
+
Whether or not article dates are displayed.
+
+
+
showAuthor
+
boolean
+
article.showAuthor
+
Whether or not the author box is displayed in the article footer.
+
+
+
showHeadingAnchors
+
boolean
+
article.showHeadingAnchors
+
Whether or not heading anchor links are displayed alongside headings within this article.
+
+
+
showPagination
+
boolean
+
article.showPagination
+
Whether or not the next/previous article links are displayed in the article footer.
+
+
+
showReadingTime
+
boolean
+
article.showReadingTime
+
Whether or not article reading times are displayed.
+
+
+
xml
+
boolean
+
true unless excluded by sitemap.excludedKinds
+
Whether or not this article is included in the generated /sitemap.xml file.
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.
+
A few things you need to set for a new installation:
It’s also useful to set the author configuration in the config/_default/author.toml file. You can also add links to your profiles here to enable them in the theme.
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 pages for a static site, posts for a blog, or projects for a portfolio.
+
The same logic applies to taxonomies. Some people prefer to use tags and categories, others prefer to use topics.
+
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:
These steps are the bare minimum configuration. If you now run hugo server you will be presented with a blank Congo website. Detailed configuration is covered in the Configuration section.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/homepage-layout/home-page.jpg b/docs/homepage-layout/home-page.jpg
new file mode 100644
index 00000000..2a619e05
Binary files /dev/null and b/docs/homepage-layout/home-page.jpg differ
diff --git a/docs/homepage-layout/home-profile-list.jpg b/docs/homepage-layout/home-profile-list.jpg
new file mode 100644
index 00000000..319da77b
Binary files /dev/null and b/docs/homepage-layout/home-profile-list.jpg differ
diff --git a/docs/homepage-layout/home-profile.jpg b/docs/homepage-layout/home-profile.jpg
new file mode 100644
index 00000000..006c8576
Binary files /dev/null and b/docs/homepage-layout/home-profile.jpg differ
diff --git a/docs/homepage-layout/index.html b/docs/homepage-layout/index.html
new file mode 100644
index 00000000..97c3d122
--- /dev/null
+++ b/docs/homepage-layout/index.html
@@ -0,0 +1,124 @@
+
+
+
+
+
+Homepage Layout · Congo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Congo provides a fully flexible homepage layout. There are two main templates to choose from with additional settings to adjust the design. Alternatively, you can also provide your own template and have complete control over the homepage content.
+
The layout of the homepage is controlled by the homepage.layout setting in the params.toml configuration file. Additionally, all layouts have the option to include a listing of recent articles.
The default layout is the page layout. It’s simply a normal content page that displays your Markdown content. It’s great for static websites and provides a lot of flexibility.
+
+
To enable the page layout, set homepage.layout = "page" in the params.toml configuration file.
The profile layout is great for personal websites and blogs. It puts the author’s details front and centre by providing an image and links to social profiles.
+
The author information is provided in the author.toml configuration file. Additionally, any Markdown content that is provided in the homepage content will be placed below the author profile. This allows extra flexibility for displaying a bio or other custom content using shortcodes.
+
+
To enable the profile layout, set homepage.layout = "profile" in the params.toml configuration file.
If the built-in homepage layouts aren’t sufficient for your needs, you have the option to provide your own custom layout. This allows you to have total control over the page content and essentially gives you a blank slate to work with.
+
To enable the custom layout, set homepage.layout = "custom" in the params.toml configuration file.
+
With the configuration value set, create a new custom.html file and place it in layouts/partials/home/custom.html. Now whatever is in the custom.html file will be placed in the content area of the site homepage. You can use whatever HTML, Tailwind, or Hugo templating functions to define your layout.
All homepage layouts have the option of displaying recent articles below the main page content. To enable this, simply set the homepage.showList setting to true in the params.toml configuration file.
+
+
The articles listed in this section are derived from the homepage.listSections setting which allows for whatever content types you are using on your website. For instance, if you had content sections for posts and projects you could set this setting to ["posts", "projects"] and all the articles in these two sections would be used to populate the recent list. The theme expects this setting to be an array so if you only use one section for all your content, you should set this accordingly: ["blog"].
+Simple, yet powerful. Learn how to use Congo and its features.
+
+
+
+
This section contains everything you need to know about Congo. If you’re new, check out the Installation guide to begin or visit the Samples section to see what Congo can do.
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/index.xml b/docs/index.xml
new file mode 100644
index 00000000..c7f60953
--- /dev/null
+++ b/docs/index.xml
@@ -0,0 +1,20 @@
+Documentation on Congohttps://jpanther.github.io/Congo/docs/Recent content in Documentation on CongoHugo -- gohugo.ioen-AUSun, 16 Aug 2020 00:00:00 +0000Installationhttps://jpanther.github.io/Congo/docs/installation/Sun, 16 Aug 2020 00:00:00 +0000https://jpanther.github.io/Congo/docs/installation/Simply follow the standard Hugo Quick Start procedure to get up and running quickly.
+Detailed instructions can be found below.
+Install Hugo # You can find specific instructions for your platform in the official Hugo docs.
+Make sure you are using Hugo version 0.86.1 or later as the theme takes advantage of some of the latest Hugo features.
+Create a new site # Run the command hugo new site mywebsite to create a new Hugo site in a folder named mywebsite.Getting Startedhttps://jpanther.github.io/Congo/docs/getting-started/Sat, 15 Aug 2020 00:00:00 +0000https://jpanther.github.io/Congo/docs/getting-started/This section assumes you have already installed the Congo theme. 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.
+A few things you need to set for a new installation:
+# config/_default/config.toml baseURL = "https://your_domain.com" languageCode = "en-AU" title = "My awesome website" It’s also useful to set the author configuration in the config/_default/author.Configurationhttps://jpanther.github.io/Congo/docs/configuration/Fri, 14 Aug 2020 00:00:00 +0000https://jpanther.github.io/Congo/docs/configuration/Congo is a highly customisable theme and uses some of the latest Hugo features to simplify how it is configured.
+The theme ships with a default configuration that gets you up and running with a basic blog or static website.
+Configuration files bundled with the theme are provided in TOML format as this is the default Hugo syntax. Feel free to convert your config to YAML or JSON if you wish.Homepage Layouthttps://jpanther.github.io/Congo/docs/homepage-layout/Thu, 13 Aug 2020 00:00:00 +0000https://jpanther.github.io/Congo/docs/homepage-layout/Congo provides a fully flexible homepage layout. There are two main templates to choose from with additional settings to adjust the design. Alternatively, you can also provide your own template and have complete control over the homepage content.
+The layout of the homepage is controlled by the homepage.layout setting in the params.toml configuration file. Additionally, all layouts have the option to include a listing of recent articles.
+Page layout # The default layout is the page layout.Front Matterhttps://jpanther.github.io/Congo/docs/front-matter/Wed, 12 Aug 2020 00:00:00 +0000https://jpanther.github.io/Congo/docs/front-matter/In addition to the default Hugo front matter parameters, Congo adds a number of additional options to customise the presentation of individual articles. All the available theme parameters are listed below.
+Front matter parameter default values are inherited from the theme’s base configuration, so you only need to specify these parameters in your front matter when you want to override the default.
+Name Type Default Description externalUrl string Not set If this article is published on a third-party website, the URL to this article.Shortcodeshttps://jpanther.github.io/Congo/docs/shortcodes/Tue, 11 Aug 2020 00:00:00 +0000https://jpanther.github.io/Congo/docs/shortcodes/In addition to all the default Hugo shortcodes, Congo adds a few extras for additional functionality.
+Alert # alert outputs its contents as a stylised message box within your article. It’s useful for drawing attention to important information that you don’t want the reader to miss.
+The input is written in Markdown so you can format it however you please.
+Example:
+{{< alert >}} **Warning!** This action is destructive! {{< /alert >}} Warning!Partialshttps://jpanther.github.io/Congo/docs/partials/Mon, 10 Aug 2020 00:00:00 +0000https://jpanther.github.io/Congo/docs/partials/Analytics # Congo provides built-in support for Fathom Analytics and Google Analytics. Fathom is a paid alternative to Google Analytics that respects user privacy. If you’re interested you can use this affiliate link to receive $10 credit and try the service.
+Fathom Analytics # To enable Fathom Analytics support, simply provide your Fathom site code in the config/_default/params.toml file. If you also use the custom domain feature of Fathom and would like to serve their script from your domain, you can also additionally provide the domain configuration value.Advanced Customisationhttps://jpanther.github.io/Congo/docs/advanced-customisation/Sun, 09 Aug 2020 00:00:00 +0000https://jpanther.github.io/Congo/docs/advanced-customisation/There are a couple of ways you can make style changes to Congo.
+If you just need to add or override some simple styles, you can do so by creating a custom.css file in your project’s static/css/ folder. This file will be loaded automatically after the theme’s default styles.
+Alternatively, if you’d like to make a major change, you can take advantage of Tailwind CSS’s JIT compiler and rebuild the entire theme CSS from scratch.
\ No newline at end of file
diff --git a/docs/installation/index.html b/docs/installation/index.html
new file mode 100644
index 00000000..400e78d9
--- /dev/null
+++ b/docs/installation/index.html
@@ -0,0 +1,136 @@
+
+
+
+
+
+Installation · Congo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
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’t have git available.
In the root folder of your website, delete the config.toml file that was generated by Hugo. Copy the entire config folder from themes/congo/config/ 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.
+
You’re now all set up to use Congo. From here you can add some content and start the Hugo server.
+
Refer to the Hugo docs for more information or read the next section to learn more about configuring the theme.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/page/1/index.html b/docs/page/1/index.html
new file mode 100644
index 00000000..e59b1d7d
--- /dev/null
+++ b/docs/page/1/index.html
@@ -0,0 +1 @@
+https://jpanther.github.io/Congo/docs/
\ No newline at end of file
diff --git a/docs/partials/index.html b/docs/partials/index.html
new file mode 100644
index 00000000..c944ad81
--- /dev/null
+++ b/docs/partials/index.html
@@ -0,0 +1,148 @@
+
+
+
+
+
+Partials · Congo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
Congo provides built-in support for Fathom Analytics and Google Analytics. Fathom is a paid alternative to Google Analytics that respects user privacy. If you’re interested you can use this affiliate link to receive $10 credit and try the service.
To enable Fathom Analytics support, simply provide your Fathom site code in the config/_default/params.toml file. If you also use the custom domain feature of Fathom and would like to serve their script from your domain, you can also additionally provide the domain configuration value. If you don’t provide a domain value, the script will load directly from Fathom DNS.
Google Analytics support is provided through the internal Hugo partial. Simply provide the googleAnalytics key in the config/_default/config.toml file and the script will be added automatically.
If you wish to use a different analytics provider on your website you can also override the analytics partial and provide your own script. Simply create the file layouts/partials/analytics.html in your project and it will automatically include it in the <head> of the website.
To add comments to your articles, Congo includes support for a comments partial that is included at the base of each article page. Simply provide a layouts/partials/comments.html which contains the code required to display your chosen comments.
+
You can use either the built-in Hugo Disqus template, or provide your own custom code. Refer to the Hugo docs for further information.
Congo provides a default set of blank favicons to get started but you can provide your own assets to override them. The easiest way to obtain new favicon assets is to generate them using a third-party provider like favicon.io.
+
Icon assets should be placed directly in the static/ folder of your website and named as per the listing below. If you use favicon.io, these will be the filenames that are automatically generated for you, but you can provide your own assets if you wish.
Alternatively, you can also completely override the default favicon behaviour and provide your own favicon HTML tags and assets. Simply provide a layouts/partials/favicons.html file in your project and this will be injected into the site <head> in place of the default assets.
Similar to the icon shortcode, you can include icons in your own templates and partials by using Congo’s icon.html partial. The partial takes one parameter which is the name of the icon to be included.
+
Example:
+
{{partial"icon.html""github"}}
+
Congo includes a number of built-in icons for social, links and other purposes. You can also provide your own icon assets by including the SVG in assets/icons/.
If you wish to insert additional code after article links, create a layouts/partials/extend-article-link.html file. This is especially powerful when combined with the badge shortcode which can be used to highlight metadata for certain articles.
The theme allows for inserting additional code directly into the <head> and <footer> sections of the template. These can be useful for providing scripts or other logic that isn’t part of the theme.
+
Simply create either layouts/partials/extend-head.html or layouts/partials/extend-footer.html and these will automatically be included in your website build. Both partials are injected as the last items in <head> and <footer> so they can be used to override theme defaults.
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/screenshot.png b/docs/screenshot.png
new file mode 100644
index 00000000..70461340
Binary files /dev/null and b/docs/screenshot.png differ
diff --git a/docs/shortcodes/index.html b/docs/shortcodes/index.html
new file mode 100644
index 00000000..f8a9e535
--- /dev/null
+++ b/docs/shortcodes/index.html
@@ -0,0 +1,172 @@
+
+
+
+
+
+Shortcodes · Congo
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
alert outputs its contents as a stylised message box within your article. It’s useful for drawing attention to important information that you don’t want the reader to miss.
+
The input is written in Markdown so you can format it however you please.
+
Example:
+
{{<alert>}}
+**Warning!** This action is destructive!
+{{</alert>}}
+
button outputs a styled button component which can be used to highlight a primary action. It has two optional variables href and target which can be used to specify the URL and target of the link.
+
Example:
+
{{<buttonhref="#button"target="_self">}}
+Call to action
+{{</button>}}
+
icon outputs an SVG icon and takes the icon name as its only parameter. The icon is scaled to match the current text size.
+
Example:
+
{{<icon"github">}}
+
Output:
+
+
+
Icons are populated using Hugo pipelines which makes them very flexible. Congo ships with a default set of icons for social, email, and generic links. If you want to add your own icons, you can simply place them in /assets/icons/ and reference them using the icon shortcode passing in the icon’s filename (without the .svg. extension).
+
Icons can also be used in partials by calling the icon partial.
lead is used to bring emphasis to the start of an article. It can be used to style an introduction, or to call out an important piece of information. Simply wrap any Markdown content in the lead shortcode.
+
Example:
+
{{<lead>}}
+When life gives you lemons, make lemonade.
+{{</lead>}}
+
mermaid allows you to draw detailed diagrams and visualisations using text. It uses MermaidJS under the hood and supports a wide variety of diagrams, charts and other output formats.
+
Simply write your Mermaid syntax within the mermaid shortcode and let the plugin do the rest.
+
Refer to the official Mermaid docs for details on syntax and supported diagram types.
+
+
+
+
+
+This is a demo of the `page` layout.
+
+
+
+
Welcome to Congo! 🎉
@@ -52,19 +69,120 @@
A simple, lightweight theme for Hugo built with Tailwind CSS.
-
This is the homepage. It’s just plain Markdown content and can render whatever you wish.
-
Perhaps you’ll link to an about page, or direct people to check out your blog posts. It’s really up to you.
+
This is a demo site built entirely using Congo. It also contains a complete set of theme documentation. Congo is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts.
+
Explore the sample pages to get a feel for what Congo can do. If you like what you see, check out the project on Github or read the Installation guide to get started.
+A simple, lightweight theme for Hugo built with Tailwind CSS.
+
+
This is a demo site built entirely using Congo. It also contains a complete set of theme documentation. Congo is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts.
+
Explore the sample pages to get a feel for what Congo can do. If you like what you see, check out the project on Github or read the Installation guide to get started.
-
+
+