From fe90990e10609f05bf2ed012aa6b4eb2e57b8cc7 Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Tue, 11 Jan 2022 10:02:51 +1100 Subject: [PATCH] =?UTF-8?q?=F0=9F=8C=90=20Restructure=20config=20for=20mul?= =?UTF-8?q?tilingual=20support?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- config/_default/config.toml | 48 ------------- config/_default/languages.en.toml | 50 +++++++++++++ config/_default/{menus.toml => menus.en.toml} | 0 exampleSite/config.toml | 71 ------------------- exampleSite/config/_default/config.toml | 11 +++ .../config/_default/languages.en-au.toml | 17 +++++ exampleSite/config/_default/markup.toml | 9 +++ exampleSite/config/_default/menus.en-au.toml | 41 +++++++++++ exampleSite/config/_default/module.toml | 3 + exampleSite/config/_default/params.toml | 54 ++++++++++++++ exampleSite/config/_default/taxonomies.toml | 1 + i18n/en-au.yaml | 40 +++++++++++ 12 files changed, 226 insertions(+), 119 deletions(-) create mode 100644 config/_default/languages.en.toml rename config/_default/{menus.toml => menus.en.toml} (100%) delete mode 100755 exampleSite/config.toml create mode 100644 exampleSite/config/_default/config.toml create mode 100644 exampleSite/config/_default/languages.en-au.toml create mode 100644 exampleSite/config/_default/markup.toml create mode 100644 exampleSite/config/_default/menus.en-au.toml create mode 100644 exampleSite/config/_default/module.toml create mode 100644 exampleSite/config/_default/params.toml create mode 100644 exampleSite/config/_default/taxonomies.toml create mode 100644 i18n/en-au.yaml diff --git a/config/_default/config.toml b/config/_default/config.toml index 034eae30..59290833 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -3,57 +3,9 @@ # https://jpanther.github.io/congo/docs/getting-started/ # baseURL = "https://your_domain.com/" -languageCode = "en" defaultContentLanguage = "en" -title = "Congo" -# copyright = "Copy, _right?_ :thinking_face:" - enableEmoji = true enableRobotsTXT = true summaryLength = 0 - -[author] - # name = "Your name here" - # image = "img/author.jpg" - # bio = "A little bit about you" - # links = [ - # { email = "mailto:hello@your_domain.com" }, - # { link = "https://link-to-some-website.com/" }, - # { amazon = "https://www.amazon.com/hz/wishlist/ls/wishlist-id" }, - # { apple = "https://www.apple.com" }, - # { blogger = "https://username.blogspot.com/" }, - # { codepen = "https://codepen.io/username" }, - # { dev = "https://dev.to/username" }, - # { discord = "https://discord.gg/invitecode" }, - # { dribbble = "https://dribbble.com/username" }, - # { facebook = "https://facebook.com/username" }, - # { flickr = "https://www.flickr.com/photos/username/" }, - # { foursquare = "https://foursquare.com/username" }, - # { github = "https://github.com/username" }, - # { gitlab = "https://gitlab.com/username" }, - # { google = "https://www.google.com/" }, - # { instagram = "https://instagram.com/username" }, - # { keybase = "https://keybase.io/username" }, - # { kickstarter = "https://www.kickstarter.com/profile/username" }, - # { lastfm = "https://lastfm.com/user/username" }, - # { linkedin = "https://linkedin.com/in/username" }, - # { mastodon = "https://mastodon.instance/@username" }, - # { medium = "https://medium.com/username" }, - # { microsoft = "https://www.microsoft.com/" }, - # { patreon = "https://www.patreon.com/username" }, - # { pinterest = "https://pinterest.com/username" }, - # { reddit = "https://reddit.com/user/username" }, - # { slack = "https://workspace.url/team/userid" }, - # { snapchat = "https://snapchat.com/add/username" }, - # { soundcloud = "https://soundcloud.com/username" }, - # { steam = "https://steamcommunity.com/profiles/userid" }, - # { telegram = "https://t.me/username" }, - # { tiktok = "https://tiktok.com/@username" }, - # { tumblr = "https://username.tumblr.com" }, - # { twitch = "https://twitch.tv/username" }, - # { twitter = "https://twitter.com/username" }, - # { whatsapp = "https://wa.me/phone-number" }, - # { youtube = "https://youtube.com/username" }, - # ] diff --git a/config/_default/languages.en.toml b/config/_default/languages.en.toml new file mode 100644 index 00000000..8ba31bd8 --- /dev/null +++ b/config/_default/languages.en.toml @@ -0,0 +1,50 @@ +languageCode = "en" +languageName = "English" +weight = 1 + +title = "Congo EN" +# copyright = "Copy, _right?_ :thinking_face:" + +[author] + # name = "Your name here" + # image = "img/author.jpg" + # bio = "A little bit about you" + # links = [ + # { email = "mailto:hello@your_domain.com" }, + # { link = "https://link-to-some-website.com/" }, + # { amazon = "https://www.amazon.com/hz/wishlist/ls/wishlist-id" }, + # { apple = "https://www.apple.com" }, + # { blogger = "https://username.blogspot.com/" }, + # { codepen = "https://codepen.io/username" }, + # { dev = "https://dev.to/username" }, + # { discord = "https://discord.gg/invitecode" }, + # { dribbble = "https://dribbble.com/username" }, + # { facebook = "https://facebook.com/username" }, + # { flickr = "https://www.flickr.com/photos/username/" }, + # { foursquare = "https://foursquare.com/username" }, + # { github = "https://github.com/username" }, + # { gitlab = "https://gitlab.com/username" }, + # { google = "https://www.google.com/" }, + # { instagram = "https://instagram.com/username" }, + # { keybase = "https://keybase.io/username" }, + # { kickstarter = "https://www.kickstarter.com/profile/username" }, + # { lastfm = "https://lastfm.com/user/username" }, + # { linkedin = "https://linkedin.com/in/username" }, + # { mastodon = "https://mastodon.instance/@username" }, + # { medium = "https://medium.com/username" }, + # { microsoft = "https://www.microsoft.com/" }, + # { patreon = "https://www.patreon.com/username" }, + # { pinterest = "https://pinterest.com/username" }, + # { reddit = "https://reddit.com/user/username" }, + # { slack = "https://workspace.url/team/userid" }, + # { snapchat = "https://snapchat.com/add/username" }, + # { soundcloud = "https://soundcloud.com/username" }, + # { steam = "https://steamcommunity.com/profiles/userid" }, + # { telegram = "https://t.me/username" }, + # { tiktok = "https://tiktok.com/@username" }, + # { tumblr = "https://username.tumblr.com" }, + # { twitch = "https://twitch.tv/username" }, + # { twitter = "https://twitter.com/username" }, + # { whatsapp = "https://wa.me/phone-number" }, + # { youtube = "https://youtube.com/username" }, + # ] diff --git a/config/_default/menus.toml b/config/_default/menus.en.toml similarity index 100% rename from config/_default/menus.toml rename to config/_default/menus.en.toml diff --git a/exampleSite/config.toml b/exampleSite/config.toml deleted file mode 100755 index bccba71d..00000000 --- a/exampleSite/config.toml +++ /dev/null @@ -1,71 +0,0 @@ -# Site configuration for the Congo demo site -# -------------------------------------------------------------------------- -# IMPORTANT: You should not use this file as a template for configuration -# as it does not contain all the required theme settings! -# -# Refer to the theme docs for configuration instructions if you're unsure. -# https://jpanther.github.io/congo/docs/ -# -------------------------------------------------------------------------- - -theme = "congo" -languageCode = "en-AU" -defaultContentLanguage = "en" -title = "Congo" -enableEmoji = true -summaryLength = 0 - -[author] - name = "Congo" - image = "img/author.jpg" - bio = "This is an example author bio, and although there's a stock photo of a dog here, this article was actually created by a human. :dog:" - links = [ - { twitter = "https://twitter.com/" }, - { facebook = "https://facebook.com/" }, - { linkedin = "https://linkedin.com/" }, - { youtube = "https://youtube.com/" }, - ] - -[taxonomies] - tag = "tags" - -[params] - # logo = "logo.jpg" - -[params.homepage] - layout = "custom" - showRecent = true - mainSections = ["samples"] - -[params.list] - groupByYear = false - showBreadcrumbs = true - -[params.article] - showBreadcrumbs = true - showEdit = true - editURL = "https://github.com/jpanther/congo/tree/dev/exampleSite/content/" - editAppendPath = true - -[[menu.main]] - name = "Docs" - pageRef = "docs" - weight = 10 -[[menu.main]] - name = "Samples" - pageRef = "samples" - weight = 20 -[[menu.main]] - name = "Users" - pageRef = "users" - weight = 30 -[[menu.main]] - name = "GitHub" - url = "https://github.com/jpanther/congo" - weight = 40 - -[markup.goldmark] -[markup.goldmark.renderer] - unsafe = true - -[markup.highlight] - noClasses = false diff --git a/exampleSite/config/_default/config.toml b/exampleSite/config/_default/config.toml new file mode 100644 index 00000000..5ea5be49 --- /dev/null +++ b/exampleSite/config/_default/config.toml @@ -0,0 +1,11 @@ +# -- Site Configuration -- +# Refer to the theme docs for more details about each of these parameters. +# https://jpanther.github.io/congo/docs/getting-started/ + +theme = "congo" +defaultContentLanguage = "en-au" + +enableEmoji = true +enableRobotsTXT = true + +summaryLength = 0 diff --git a/exampleSite/config/_default/languages.en-au.toml b/exampleSite/config/_default/languages.en-au.toml new file mode 100644 index 00000000..5dfa40fb --- /dev/null +++ b/exampleSite/config/_default/languages.en-au.toml @@ -0,0 +1,17 @@ +languageCode = "en-AU" +languageName = "English (Australia)" +weight = 1 + +title = "Congo :flag-au:" +# copyright = "Copy, _right?_ :thinking_face:" + +[author] + name = "Congo" + image = "img/author.jpg" + bio = "This is an example author bio, and although there's a stock photo of a dog here, this article was actually created by a human. :dog:" + links = [ + { twitter = "https://twitter.com/" }, + { facebook = "https://facebook.com/" }, + { linkedin = "https://linkedin.com/" }, + { youtube = "https://youtube.com/" }, + ] diff --git a/exampleSite/config/_default/markup.toml b/exampleSite/config/_default/markup.toml new file mode 100644 index 00000000..2ca49b3b --- /dev/null +++ b/exampleSite/config/_default/markup.toml @@ -0,0 +1,9 @@ +# -- Markup -- +# These settings are required for the theme to function. + +[goldmark] +[goldmark.renderer] + unsafe = true + +[highlight] + noClasses = false diff --git a/exampleSite/config/_default/menus.en-au.toml b/exampleSite/config/_default/menus.en-au.toml new file mode 100644 index 00000000..e51dda49 --- /dev/null +++ b/exampleSite/config/_default/menus.en-au.toml @@ -0,0 +1,41 @@ +# -- Main Menu -- +# The main menu is displayed in the header at the top of the page. +# Acceptable parameters are name, pageRef, page, url, title, weight. +# +# The simplest menu configuration is to provide: +# name = The name to be displayed for this menu link +# pageRef = The identifier of the page or section to link to +# +# By default the menu is ordered alphabetically. This can be +# overridden by providing a weight value. The menu will then be +# ordered by weight from lowest to highest. + +[[main]] + name = "Docs" + pageRef = "docs" + weight = 10 + +[[main]] + name = "Samples" + pageRef = "samples" + weight = 20 + +[[main]] + name = "Users" + pageRef = "users" + weight = 30 + +[[main]] + name = "GitHub" + url = "https://github.com/jpanther/congo" + weight = 40 + + +# -- Footer Menu -- +# The footer menu is displayed at the bottom of the page, just before +# the copyright notice. Configure as per the main menu above. + +# [[footer]] +# name = "Tags" +# pageRef = "tags" +# weight = 10 diff --git a/exampleSite/config/_default/module.toml b/exampleSite/config/_default/module.toml new file mode 100644 index 00000000..6a8e43fa --- /dev/null +++ b/exampleSite/config/_default/module.toml @@ -0,0 +1,3 @@ +[hugoVersion] + extended = false + min = "0.86.1" diff --git a/exampleSite/config/_default/params.toml b/exampleSite/config/_default/params.toml new file mode 100644 index 00000000..ddbfebf9 --- /dev/null +++ b/exampleSite/config/_default/params.toml @@ -0,0 +1,54 @@ +# -- Theme Options -- +# These options control how the theme functions and allow you to +# customise the display of your website. +# +# Refer to the theme docs for more details about each of these parameters. +# https://jpanther.github.io/congo/docs/configuration/#theme-parameters + +colorScheme = "congo" +# darkMode = "auto" +# darkToggle = false +# logo = "img/logo.jpg" +# description = "My awesome website" +mainSections = ["samples"] +# robots = "" + +[homepage] + layout = "custom" # valid options: page, profile, custom + showRecent = true + +[article] + showDate = true + dateFormat = "2 January 2006" + showAuthor = true + showBreadcrumbs = false + showDraftLabel = true + showEdit = true + editURL = "https://github.com/jpanther/congo/tree/dev/exampleSite/content/" + editAppendPath = true + showHeadingAnchors = true + showPagination = true + showReadingTime = true + showWordCount = false + # sharingLinks = ["facebook", "twitter", "pinterest", "reddit", "linkedin", "email"] + +[list] + showBreadcrumbs = true + showSummary = false + groupByYear = false + +[taxonomy] + showTermCount = true + +[sitemap] + excludedKinds = ["taxonomy", "term"] + +[fathomAnalytics] + # site = "ABC12345" + # domain = "llama.yoursite.com" + +[verification] + # google = "" + # bing = "" + # pinterest = "" + # yandex = "" diff --git a/exampleSite/config/_default/taxonomies.toml b/exampleSite/config/_default/taxonomies.toml new file mode 100644 index 00000000..193dc4bb --- /dev/null +++ b/exampleSite/config/_default/taxonomies.toml @@ -0,0 +1 @@ +tag = "tags" diff --git a/i18n/en-au.yaml b/i18n/en-au.yaml new file mode 100644 index 00000000..6cb5c3d5 --- /dev/null +++ b/i18n/en-au.yaml @@ -0,0 +1,40 @@ +article: + anchor_label: "Anchor" + draft: "Draft" + edit_title: "Edit content" + reading_time: + one: "{{ .Count }} min" + other: "{{ .Count }} mins" + reading_time_title: "Reading time" + word_count: + one: "{{ .Count }} word" + other: "{{ .Count }} words" + +author: + byline_title: "Author" + +error: + 404_title: "Page Not Found :confused:" + 404_error: "Error 404" + 404_description: "It seems that the page you've requested does not exist." + +footer: + dark_appearance: "Switch to dark appearance" + light_appearance: "Switch to light appearance" + powered_by: "Powered by {{ .Hugo }} & {{ .Congo }}" + +list: + externalurl_title: "Link to external site" + no_articles: "There's no articles to list here yet." + +sharing: + email: "Send via email" + facebook: "Share on Facebook" + linkedin: "Share on LinkedIn" + pinterest: "Pin on Pinterest" + reddit: "Submit to Reddit" + twitter: "Tweet on Twitter" + +shortcode: + recent_articles: "Recent" + icon_none: "Icon not found."