diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index 6e0d8d51..1697ef84 100755 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -24,6 +24,6 @@ This is a demo site built entirely using Congo. It also contains a complete set -Explore the [sample pages]({{< ref "samples" >}}) to get a feel for what Congo can do. If you like what you see, check out the project on [Github](https://github.com/jpanther/congo) or read the [Installation guide]({{< ref "docs/installation" >}}) to get started. +{{< figure src="festivities.svg" class="m-auto mt-6 max-w-prose" >}} -![A stylised photograph of a purple squid on a pink backdrop.](squid.jpg "Photo by [Jippe Joosten](https://unsplash.com/@jippe_joosten?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText) on [Unsplash](https://unsplash.com/s/photos/vibrant-purple?utm_source=unsplash&utm_medium=referral&utm_content=creditCopyText).") +Explore the [sample pages]({{< ref "samples" >}}) to get a feel for what Congo can do. If you like what you see, check out the project on [Github](https://github.com/jpanther/congo) or read the [Installation guide]({{< ref "docs/installation" >}}) to get started. diff --git a/exampleSite/content/docs/_index.md b/exampleSite/content/docs/_index.md index a6a2c4b1..e7c2325a 100755 --- a/exampleSite/content/docs/_index.md +++ b/exampleSite/content/docs/_index.md @@ -5,6 +5,7 @@ description: "Learn how to use Congo and its features." cascade: showDate: false showAuthor: false + showSummary: true invertPagination: true --- @@ -16,4 +17,6 @@ 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]({{< ref "docs/installation" >}}) guide to begin or visit the [Samples]({{< ref "samples" >}}) section to see what Congo can do. +_Special thanks to [Katerina Limpitsouni](https://ninalimpi.com) for the excellent illustrations that are used throughout these docs!_ + --- diff --git a/exampleSite/content/docs/advanced-customisation.md b/exampleSite/content/docs/advanced-customisation/index.md similarity index 98% rename from exampleSite/content/docs/advanced-customisation.md rename to exampleSite/content/docs/advanced-customisation/index.md index b8d52423..b07a6c5e 100644 --- a/exampleSite/content/docs/advanced-customisation.md +++ b/exampleSite/content/docs/advanced-customisation/index.md @@ -3,6 +3,7 @@ title: "Advanced Customisation" date: 2020-08-08 draft: false description: "Learn how to build Congo manually." +summary: "Congo supports advanced customisations that include modifying the underlying Tailwind configuration, building the theme manually and providing custom CSS." slug: "advanced-customisation" tags: ["advanced", "css", "docs"] --- diff --git a/exampleSite/content/docs/advanced-customisation/thumb-static-website.svg b/exampleSite/content/docs/advanced-customisation/thumb-static-website.svg new file mode 100644 index 00000000..23b1caff --- /dev/null +++ b/exampleSite/content/docs/advanced-customisation/thumb-static-website.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/exampleSite/content/docs/configuration.md b/exampleSite/content/docs/configuration/index.md similarity index 99% rename from exampleSite/content/docs/configuration.md rename to exampleSite/content/docs/configuration/index.md index 4eb23596..0f684d2a 100644 --- a/exampleSite/content/docs/configuration.md +++ b/exampleSite/content/docs/configuration/index.md @@ -3,6 +3,7 @@ title: "Configuration" date: 2020-08-14 draft: false description: "All the configuration variables available in Congo." +summary: "Discover all the site, language and theme configurations that are available in Congo and how they can be used to customise your project." slug: "configuration" tags: ["config", "docs"] --- diff --git a/exampleSite/content/docs/configuration/thumb-setup.svg b/exampleSite/content/docs/configuration/thumb-setup.svg new file mode 100644 index 00000000..4a35b780 --- /dev/null +++ b/exampleSite/content/docs/configuration/thumb-setup.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/exampleSite/content/docs/content-examples.md b/exampleSite/content/docs/content-examples/index.md similarity index 98% rename from exampleSite/content/docs/content-examples.md rename to exampleSite/content/docs/content-examples/index.md index ef577f09..bdfa433c 100644 --- a/exampleSite/content/docs/content-examples.md +++ b/exampleSite/content/docs/content-examples/index.md @@ -2,7 +2,8 @@ title: "Content Examples" date: 2020-08-09 draft: false -description: "All the partials available in Congo." +description: "Some examples that demonstrate how content should be created and structured." +summary: "It's time to bring everything together with some examples that demonstrate how content should be created and structured." slug: "content-examples" tags: ["content", "example"] --- diff --git a/exampleSite/content/docs/content-examples/thumb-inspiration.svg b/exampleSite/content/docs/content-examples/thumb-inspiration.svg new file mode 100644 index 00000000..7fbf6150 --- /dev/null +++ b/exampleSite/content/docs/content-examples/thumb-inspiration.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/exampleSite/content/docs/front-matter.md b/exampleSite/content/docs/front-matter/index.md similarity index 97% rename from exampleSite/content/docs/front-matter.md rename to exampleSite/content/docs/front-matter/index.md index 48b7318e..4932051a 100644 --- a/exampleSite/content/docs/front-matter.md +++ b/exampleSite/content/docs/front-matter/index.md @@ -3,6 +3,7 @@ title: "Front Matter" date: 2020-08-12 draft: false description: "All the front matter variables available in Congo." +summary: "While supporting most Hugo defaults, Congo adds a number of front matter parameters to customise the presentation of individual articles." slug: "front-matter" tags: ["front matter", "config", "docs"] --- diff --git a/exampleSite/content/docs/front-matter/thumb-file-analysis.svg b/exampleSite/content/docs/front-matter/thumb-file-analysis.svg new file mode 100644 index 00000000..bf4cc304 --- /dev/null +++ b/exampleSite/content/docs/front-matter/thumb-file-analysis.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/exampleSite/content/docs/getting-started/index.md b/exampleSite/content/docs/getting-started/index.md index 35c66141..9ec70013 100644 --- a/exampleSite/content/docs/getting-started/index.md +++ b/exampleSite/content/docs/getting-started/index.md @@ -2,7 +2,8 @@ title: "Getting Started" date: 2020-08-15 draft: false -description: "All the front matter variables available in Congo." +description: "Learn how to get started using the Congo theme." +summary: "This section assumes you have already installed the Congo theme and are ready to start with basic configuration tasks." slug: "getting-started" tags: ["installation", "docs"] --- diff --git a/exampleSite/content/docs/getting-started/thumb-choose.svg b/exampleSite/content/docs/getting-started/thumb-choose.svg new file mode 100644 index 00000000..773169f8 --- /dev/null +++ b/exampleSite/content/docs/getting-started/thumb-choose.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/exampleSite/content/docs/homepage-layout/index.md b/exampleSite/content/docs/homepage-layout/index.md index e0551be2..9c5b48bc 100644 --- a/exampleSite/content/docs/homepage-layout/index.md +++ b/exampleSite/content/docs/homepage-layout/index.md @@ -3,6 +3,7 @@ title: "Homepage Layout" date: 2020-08-13 draft: false description: "Configuring the homepage layout in the Congo theme." +summary: "Congo provides a fully flexible homepage layout with built-in templates and the ability to provide your own." slug: "homepage-layout" tags: ["homepage", "layouts", "docs"] --- diff --git a/exampleSite/content/docs/homepage-layout/thumb-heatmap.svg b/exampleSite/content/docs/homepage-layout/thumb-heatmap.svg new file mode 100644 index 00000000..35a64cab --- /dev/null +++ b/exampleSite/content/docs/homepage-layout/thumb-heatmap.svg @@ -0,0 +1 @@ +heatmap \ No newline at end of file diff --git a/exampleSite/content/docs/hosting-deployment/index.md b/exampleSite/content/docs/hosting-deployment/index.md index 93e6c557..9752a06e 100644 --- a/exampleSite/content/docs/hosting-deployment/index.md +++ b/exampleSite/content/docs/hosting-deployment/index.md @@ -3,6 +3,7 @@ title: "Hosting & Deployment" date: 2020-08-07 draft: false description: "Learn how to deploy a Congo site." +summary: "Congo is designed to be flexible in almost any deployment scenario. Learn more about how to deploy your project to some common hosting platforms." slug: "hosting-deployment" tags: ["hosting", "deployment", "docs", "github", "netlify", "render"] --- @@ -95,15 +96,15 @@ Then in the root of your site repository, create a `netlify.toml` file: [build.environment] NODE_ENV = "production" - GO_VERSION = "1.16" + GO_VERSION = "1.19" TZ = "UTC" # Set to preferred timezone [context.production.environment] - HUGO_VERSION = "0.105.0" + HUGO_VERSION = "0.109.0" HUGO_ENV = "production" [context.deploy-preview.environment] - HUGO_VERSION = "0.105.0" + HUGO_VERSION = "0.109.0" ``` This configuration assumes you are deploying Congo as a Hugo module. If you have installed the theme using another method, change the build command to simply `hugo --gc --minify -b $URL`. diff --git a/exampleSite/content/docs/hosting-deployment/thumb-server-down.svg b/exampleSite/content/docs/hosting-deployment/thumb-server-down.svg new file mode 100644 index 00000000..e1bab071 --- /dev/null +++ b/exampleSite/content/docs/hosting-deployment/thumb-server-down.svg @@ -0,0 +1 @@ +server down \ No newline at end of file diff --git a/exampleSite/content/docs/installation.md b/exampleSite/content/docs/installation/index.md similarity index 98% rename from exampleSite/content/docs/installation.md rename to exampleSite/content/docs/installation/index.md index 936c20ec..422d0077 100644 --- a/exampleSite/content/docs/installation.md +++ b/exampleSite/content/docs/installation/index.md @@ -3,6 +3,7 @@ title: "Installation" date: 2020-08-16 draft: false description: "How to install the Congo theme." +summary: "Learn how to get up and running using Hugo and Congo from a completely blank state. It's the best place to start if you're a new user." slug: "installation" tags: ["installation", "docs"] --- diff --git a/exampleSite/content/docs/installation/thumb-cloud-files.svg b/exampleSite/content/docs/installation/thumb-cloud-files.svg new file mode 100644 index 00000000..545fd910 --- /dev/null +++ b/exampleSite/content/docs/installation/thumb-cloud-files.svg @@ -0,0 +1 @@ +cloud_files \ No newline at end of file diff --git a/exampleSite/content/docs/partials.md b/exampleSite/content/docs/partials/index.md similarity index 97% rename from exampleSite/content/docs/partials.md rename to exampleSite/content/docs/partials/index.md index bf0f0a3c..abb44d5a 100644 --- a/exampleSite/content/docs/partials.md +++ b/exampleSite/content/docs/partials/index.md @@ -3,6 +3,7 @@ title: "Partials" date: 2020-08-10 draft: false description: "All the partials available in Congo." +summary: "Partials are used to add special functionality to the theme including analytics, comments, favicons, custom scripts and more." slug: "partials" tags: ["partials", "analytics", "privacy", "comments", "favicons", "icon", "docs"] --- diff --git a/exampleSite/content/docs/partials/thumb-charts.svg b/exampleSite/content/docs/partials/thumb-charts.svg new file mode 100644 index 00000000..3435c376 --- /dev/null +++ b/exampleSite/content/docs/partials/thumb-charts.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index ed0e2d4b..14607a87 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -3,6 +3,7 @@ title: "Shortcodes" date: 2020-08-11 draft: false description: "All the shortcodes available in Congo." +summary: Congo includes several shortcodes for adding rich content to articles including images, charts, diagrams, buttons and more. slug: "shortcodes" tags: ["shortcodes", "mermaid", "icon", "lead", "docs"] --- diff --git a/exampleSite/content/docs/shortcodes/thumb-website-builder.svg b/exampleSite/content/docs/shortcodes/thumb-website-builder.svg new file mode 100644 index 00000000..d092cc80 --- /dev/null +++ b/exampleSite/content/docs/shortcodes/thumb-website-builder.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/exampleSite/content/docs/version-2/_index.md b/exampleSite/content/docs/version-2/_index.md index 972f1050..44645557 100644 --- a/exampleSite/content/docs/version-2/_index.md +++ b/exampleSite/content/docs/version-2/_index.md @@ -3,6 +3,7 @@ title: "What's New in 2.0 ✨" date: 2022-01-19 draft: false description: "Discover what's new in Congo version 2.0." +summary: "Version 2 takes Congo to new heights, making the theme even more powerful while still maintaining its lightweight footprint." tags: ["new", "docs"] --- diff --git a/exampleSite/content/docs/version-2/thumb-online-party.svg b/exampleSite/content/docs/version-2/thumb-online-party.svg new file mode 100644 index 00000000..31cf2adb --- /dev/null +++ b/exampleSite/content/docs/version-2/thumb-online-party.svg @@ -0,0 +1 @@ + diff --git a/exampleSite/content/festivities.svg b/exampleSite/content/festivities.svg new file mode 100644 index 00000000..872d4c28 --- /dev/null +++ b/exampleSite/content/festivities.svg @@ -0,0 +1 @@ +festivities \ No newline at end of file diff --git a/exampleSite/content/squid.jpg b/exampleSite/content/squid.jpg deleted file mode 100644 index 67b12241..00000000 Binary files a/exampleSite/content/squid.jpg and /dev/null differ diff --git a/exampleSite/content/users/cover-true-love.svg b/exampleSite/content/users/cover-true-love.svg new file mode 100644 index 00000000..af687155 --- /dev/null +++ b/exampleSite/content/users/cover-true-love.svg @@ -0,0 +1 @@ +true_love \ No newline at end of file diff --git a/exampleSite/content/users.md b/exampleSite/content/users/index.md similarity index 95% rename from exampleSite/content/users.md rename to exampleSite/content/users/index.md index aa673edf..3923ddfb 100644 --- a/exampleSite/content/users.md +++ b/exampleSite/content/users/index.md @@ -12,9 +12,11 @@ showEdit: false --- {{< lead >}} -Real websites that are built with Congo. +Real websites that have been built using Congo. {{< /lead >}} +The list below is just a handful of the websites that are built using the Congo theme. Check them out to discover some great exampels of what the theme can do. + | Website | Details | | ---------------------------------------------------------------------- | ----------------------------- | | [jamespanther.com](https://jamespanther.com) | Personal site - Theme author | diff --git a/exampleSite/layouts/shortcodes/swatches.html b/exampleSite/layouts/shortcodes/swatches.html index 322db53e..974dba74 100644 --- a/exampleSite/layouts/shortcodes/swatches.html +++ b/exampleSite/layouts/shortcodes/swatches.html @@ -1,14 +1,14 @@