diff --git a/CHANGELOG.md b/CHANGELOG.md index d33f3d8c..e2279c7c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,27 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), ## [Unreleased] +## [1.4.0] - 2021-10-20 + +### Added + +- Footer menu +- Article summary support +- Slate colour scheme ([#9](https://github.com/jpanther/congo/pull/9)) +- Icons for ORCID and ResearchGate ([#9](https://github.com/jpanther/congo/pull/9)) +- Pinterest sharing links +- Sharing links can now be specified in front matter + +### Changed + +- Main menu is now optional +- Upgrade to Mermaid v8.13.3 +- Upgrade to Tailwind v2.2.17 + +### Fixed + +- Site logo not linked to home page ([#13](https://github.com/jpanther/congo/issues/13)) + ## [1.3.0] - 2021-09-29 ### Added @@ -55,13 +76,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Some links missing the correct styles when in Firefox - `externalUrl` front matter not working on some list pages -## [1.1.1] - 2020-08-19 +## [1.1.1] - 2021-08-19 ### Fixed - Hotfix for exampleSite and GitHub configuration -## [1.1.0] - 2020-08-18 +## [1.1.0] - 2021-08-18 ### Added @@ -83,7 +104,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - URLs being incorrect in some cases when the site is deployed in a subfolder -## [1.0.0] - 2020-08-16 +## [1.0.0] - 2021-08-16 ### Added @@ -106,7 +127,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), - Advanced customisation using simple Tailwind colour definitions and styles - Fully documented -[unreleased]: https://github.com/jpanther/Congo/compare/v1.3.0...HEAD +[unreleased]: https://github.com/jpanther/Congo/compare/v1.4.0...HEAD +[1.4.0]: https://github.com/jpanther/Congo/compare/v1.3.0...v1.4.0 [1.3.0]: https://github.com/jpanther/Congo/compare/v1.2.1...v1.3.0 [1.2.1]: https://github.com/jpanther/Congo/compare/v1.2.0...v1.2.1 [1.2.0]: https://github.com/jpanther/Congo/compare/v1.1.1...v1.2.0 diff --git a/assets/css/compiled/main.css b/assets/css/compiled/main.css index ebcd58fb..7158c43a 100644 --- a/assets/css/compiled/main.css +++ b/assets/css/compiled/main.css @@ -1,6 +1,6 @@ -/*! Congo v1.3.0 | MIT License | https://github.com/jpanther/congo */ +/*! Congo v1.4.0 | MIT License | https://github.com/jpanther/congo */ -/*! tailwindcss v2.2.16 | MIT License | https://tailwindcss.com */ +/*! tailwindcss v2.2.17 | MIT License | https://tailwindcss.com */ /*! modern-normalize v1.1.0 | MIT License | https://github.com/sindresorhus/modern-normalize */ @@ -2299,6 +2299,11 @@ body a, body button { padding-right: 0.25rem; } +.py-1 { + padding-top: 0.25rem; + padding-bottom: 0.25rem; +} + .py-\[1px\] { padding-top: 1px; padding-bottom: 1px; @@ -2341,6 +2346,10 @@ body a, body button { padding-top: 0.75rem; } +.pb-4 { + padding-bottom: 1rem; +} + .pt-4 { padding-top: 1rem; } diff --git a/assets/css/main.css b/assets/css/main.css index deccc633..084018eb 100644 --- a/assets/css/main.css +++ b/assets/css/main.css @@ -1,4 +1,4 @@ -/*! Congo v1.3.0 | MIT License | https://github.com/jpanther/congo */ +/*! Congo v1.4.0 | MIT License | https://github.com/jpanther/congo */ @tailwind base; @tailwind components; diff --git a/assets/css/schemes/slate.css b/assets/css/schemes/slate.css new file mode 100644 index 00000000..000ba078 --- /dev/null +++ b/assets/css/schemes/slate.css @@ -0,0 +1,37 @@ +/* Slate scheme */ +:root { + --color-neutral: #fff; + /* Cool Gray */ + --color-neutral-50: #F9FAFB; + --color-neutral-100: #F3F4F6; + --color-neutral-200: #E5E7EB; + --color-neutral-300: #D1D5DB; + --color-neutral-400: #9CA3AF; + --color-neutral-500: #6B7280; + --color-neutral-600: #4B5563; + --color-neutral-700: #374151; + --color-neutral-800: #1F2937; + --color-neutral-900: #111827; + /* Cool Gray */ + --color-primary-50: #F9FAFB; + --color-primary-100: #F3F4F6; + --color-primary-200: #E5E7EB; + --color-primary-300: #D1D5DB; + --color-primary-400: #9CA3AF; + --color-primary-500: #6B7280; + --color-primary-600: #4B5563; + --color-primary-700: #374151; + --color-primary-800: #1F2937; + --color-primary-900: #111827; + /* Cool Gray */ + --color-secondary-50: #F9FAFB; + --color-secondary-100: #F3F4F6; + --color-secondary-200: #E5E7EB; + --color-secondary-300: #D1D5DB; + --color-secondary-400: #9CA3AF; + --color-secondary-500: #6B7280; + --color-secondary-600: #4B5563; + --color-secondary-700: #374151; + --color-secondary-800: #1F2937; + --color-secondary-900: #111827; +} diff --git a/assets/icons/orcid.svg b/assets/icons/orcid.svg new file mode 100644 index 00000000..65aa73b8 --- /dev/null +++ b/assets/icons/orcid.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/assets/icons/researchgate.svg b/assets/icons/researchgate.svg new file mode 100644 index 00000000..d4377d58 --- /dev/null +++ b/assets/icons/researchgate.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/config/_default/config.toml b/config/_default/config.toml index 0a6e258c..1606695c 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -12,6 +12,8 @@ title = "Congo" enableEmoji = true enableRobotsTXT = true +summaryLength = 0 + [author] # name = "Your name here" # image = "img/author.jpg" diff --git a/config/_default/menus.toml b/config/_default/menus.toml index 7d0c31f4..16298213 100644 --- a/config/_default/menus.toml +++ b/config/_default/menus.toml @@ -1,5 +1,5 @@ # -- Main Menu -- -# The main menu is displayed at the top of the theme. +# 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: @@ -24,3 +24,13 @@ name = "Tags" pageRef = "tags" weight = 30 + + +# -- 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/config/_default/params.toml b/config/_default/params.toml index e5ad4f4d..e246751d 100644 --- a/config/_default/params.toml +++ b/config/_default/params.toml @@ -27,10 +27,11 @@ colorScheme = "congo" showHeadingAnchors = true showPagination = true showReadingTime = true - # sharingLinks = ["facebook", "twitter", "reddit", "linkedin", "email"] + # sharingLinks = ["facebook", "twitter", "pinterest", "reddit", "linkedin", "email"] [list] showBreadcrumbs = false + showSummary = false groupByYear = true [taxonomy] diff --git a/data/sharing.json b/data/sharing.json index ff9dbc54..34e60899 100644 --- a/data/sharing.json +++ b/data/sharing.json @@ -14,6 +14,11 @@ "title": "sharing.linkedin", "url": "https://www.linkedin.com/shareArticle?mini=true&url=%s&title=%s" }, + "pinterest": { + "icon": "pinterest", + "title": "sharing.pinterest", + "url": "https://pinterest.com/pin/create/bookmarklet/?url=%s&description=%s" + }, "reddit": { "icon": "reddit", "title": "sharing.reddit", diff --git a/exampleSite/config.toml b/exampleSite/config.toml index aec2100e..415e1807 100755 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -12,6 +12,7 @@ languageCode = "en-AU" defaultContentLanguage = "en" title = "Congo" enableEmoji = true +summaryLength = 0 [author] name = "Congo" diff --git a/exampleSite/content/docs/advanced-customisation.md b/exampleSite/content/docs/advanced-customisation.md index f1cd88ec..73d00c22 100644 --- a/exampleSite/content/docs/advanced-customisation.md +++ b/exampleSite/content/docs/advanced-customisation.md @@ -11,9 +11,9 @@ There are a few ways you can make style changes to Congo. ## Colour schemes -Congo ships with a few colour schemes out of the box. To change the basic colour scheme, you can set the `colorScheme` theme parameter to one of the default configurations. Valid options are `congo` (the default), `avocado`, `fire` and `ocean`. +Congo ships with a number of colour schemes out of the box. To change the basic colour scheme, you can set the `colorScheme` theme parameter. Refer to the [Getting Started]({{< ref "getting-started#colour-schemes" >}}) section to learn more about the built-in schemes. -In addition to the default scheme, you can also create your own and restyle the entire website to your liking. Schemes are created by by placing a `.css` file in the `assets/css/schemes/` folder. Once the file is created, simply refer to it by name in the theme configuration. +In addition to the default schemes, you can also create your own and re-style the entire website to your liking. Schemes are created by by placing a `.css` file in the `assets/css/schemes/` folder. Once the file is created, simply refer to it by name in the theme configuration. Congo defines a three-colour palette that is used throughout the theme. The three colours are defined as `neutral`, `primary` and `secondary` variants, each containing ten shades of colour. diff --git a/exampleSite/content/docs/configuration.md b/exampleSite/content/docs/configuration.md index 1e6bd5cb..402092ad 100644 --- a/exampleSite/content/docs/configuration.md +++ b/exampleSite/content/docs/configuration.md @@ -19,7 +19,7 @@ The default theme configuration is documented in each file so you can freely adj As outlined in the [installation instructions]({{< ref "/docs/installation#set-up-theme-configuration-files" >}}), 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. {{< /alert >}} -## Site Configuration +## Site configuration Standard Hugo configuration variables are respected throughout the theme, however there are some specific things that should be configured for the best experience. @@ -30,22 +30,23 @@ Note that the variable names provided in this table use dot notation to simplify |Name|Type|Default|Description| | --- | --- | --- | --- | -|`theme`|string|`"congo"`|When using Hugo Modules this config value should be removed. For all other installation types, this must be set to `"congo"` for the theme to function.| +|`theme`|string|`"congo"`|When using Hugo Modules this config value should be removed. For all other installation types, this must be set to `congo` for the theme to function.| |`baseURL`|string|_Not set_|The URL to the root of the website.| -|`languageCode`|string|`en`|The language of the website for site metadata purposes. It can be a top-level language (ie. `"en"`) or a sub-variant (ie. `en-AU`)."| +|`languageCode`|string|`"en"`|The language of the website for site metadata purposes. It can be a top-level language (ie. `en`) or a sub-variant (ie. `en-AU`)."| |`defaultContentLanguage`|string|`"en"`|This value determines the language of theme components."| |`title`|string|`"Congo"`|The title of the website. This will be displayed in the site header and footer.| |`copyright`|string|_Not set_|A Markdown string containing the copyright message to be displayed in the site footer. If none is provided, Congo will automatically generate a copyright string using the site `title`. |`enableEmoji`|boolean|`true`|Whether emoji strings in content should be converted to emoji symbols.| |`enableRobotsTXT`|boolean|`true`|When enabled a `robots.txt` file will be created in the site root that allows search engines to crawl the entire site. Set to `false` if you wish to provide your own file.| +|`summaryLength`|integer|`0`|The number of words that are used to generate the article summary when one is not provided in the [front matter]({{< ref "front-matter" >}}). A value of `0` will use the first sentence. This value has no effect when summaries are hidden.| |`author.name`|string|_Not set_|The author's name. This will be displayed in article footers, and on the homepage when the profile layout is used.| |`author.image`|string|_Not set_|Path to the image file of the author. The image should be a 1:1 aspect ratio and placed in the site's `static/` folder.| |`author.links`|array of objects|_Not set_|The links to display alongside the author's details. The config file contains example links which can simply be uncommented to enable. The order that the links are displayed is determined by the order they appear in the array. Custom links can be added by providing corresponding SVG icon assets in `assets/icons/`.| -|`[permalinks]`||_Not set_|Refer to the [Hugo docs](https://gohugo.io/content-management/urls/#permalinks) for permalink configuration.| -|`[taxonomies]`||_Not set_|Refer to the [Hugo docs](https://gohugo.io/content-management/taxonomies/) for taxonomy configuration.| +|`permalinks`||_Not set_|Refer to the [Hugo docs](https://gohugo.io/content-management/urls/#permalinks) for permalink configuration.| +|`taxonomies`||_Not set_|Refer to the [Organising content]({{< ref "getting-started#organising-content" >}}) section for taxonomy configuration.| -## Theme Parameters +## Theme parameters 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. @@ -54,8 +55,8 @@ Many of the article defaults here can be overridden on a per article basis by sp |Name|Type|Default|Description| | --- | --- | --- | --- | -|`colorScheme`|string|`"congo"`|The theme colour scheme to use. Valid values are `congo` (default), `avocado`, `ocean` and `fire`. Refer to [Advanced Customisation]({{< ref "advanced-customisation#colour-schemes" >}}) for more details.| -|`logo`|string|_Not set_|The relative path to the site logo file within the Hugo assets folder. The logo file should be provided at 2x resolution and supports any image dimensions.| +|`colorScheme`|string|`"congo"`|The theme colour scheme to use. Valid values are `congo` (default), `avocado`, `ocean`, `fire` and `slate`. Refer to the [Colour Schemes]({{< ref "getting-started#colour-schemes" >}}) section for more details.| +|`logo`|string|_Not set_|The relative path to the site logo file within the `assets/` folder. The logo file should be provided at 2x resolution and supports any image dimensions.| |`description`|string|_Not set_|The description of the website for metadata purposes.| |`mainSections`|array of strings|_Not set_|The sections that should be displayed in the recent articles list. If not provided the section with the greatest number of articles is used.| |`robots`|string|_Not set_|String that indicates how robots should handle your site. If set, it will be output in the page head. Refer to [Google's docs](https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives) for valid values.| @@ -74,10 +75,11 @@ Many of the article defaults here can be overridden on a per article basis by sp |`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.showBreadcrumbs`|boolean|`false`|Whether or not breadcrumbs are displayed in the header on list pages.| +|`list.showSummary`|boolean|`false`|Whether or not article summaries are displayed on list pages. If a summary is not provided in the [front matter]({{< ref "front-matter" >}}), one will be auto generated using the `summaryLength` parameter in the [site configuration](#site-configuration).| |`list.groupByYear`|boolean|`true`|Whether or not articles are grouped by year on list pages.| |`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](https://gohugo.io/templates/section-templates/#page-kinds) 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]({{< ref "partials#analytics" >}}) below for more details.| +|`fathomAnalytics.site`|string|_Not set_|The site code generated by Fathom Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) 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.| diff --git a/exampleSite/content/docs/front-matter.md b/exampleSite/content/docs/front-matter.md index 334bd682..b8913d2d 100644 --- a/exampleSite/content/docs/front-matter.md +++ b/exampleSite/content/docs/front-matter.md @@ -7,22 +7,27 @@ slug: "front-matter" tags: ["front matter", "config", "docs"] --- -In addition to the [default Hugo front matter parameters](https://gohugo.io/content-management/front-matter/#front-matter-variables), Congo adds a number of additional options to customise the presentation of individual articles. All the available theme parameters are listed below. +In addition to the [default Hugo front matter parameters](https://gohugo.io/content-management/front-matter/#front-matter-variables), Congo adds a number of additional options to customise the presentation of individual articles. All the available theme front matter parameters are listed below. Front matter parameter default values are inherited from the theme's [base configuration]({{< ref "configuration" >}}), so you only need to specify these parameters in your front matter when you want to override the default. |Name|Type|Default|Description| | --- | --- | --- | --- | +|`description`|string|_Not set_|The text description for the article. It is used in the HTML metadata.| |`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.| -|`showEdit`|boolean|`article.showEdit`|Whether or not the link to edit the article content should be displayed.| |`editURL`|string|`article.editURL`|When `showEdit` is active, the URL for the edit link.| |`editAppendPath`|boolean|`article.editAppendPath`|When `showEdit` is active, whether or not the path to the current article should be appended to the URL set at `editURL`.| +|`menu`|string or array|_Not set_|When a value is provided, a link to this article will appear in the named menus. Valid values are `main` or `footer`.| |`robots`|string|_Not set_|String that indicates how robots should handle this article. If set, it will be output in the page head. Refer to [Google's docs](https://developers.google.com/search/docs/advanced/robots/robots_meta_tag#directives) for valid values.| +|`sharingLinks`|array of strings|`article.sharingLinks`|Which sharing links to display at the end of this article. When not provided, or set to `false` no links will be displayed.| +|`showAuthor`|boolean|`article.showAuthor`|Whether or not the author box is displayed in the article footer.| +|`showDate`|boolean|`article.showDate`|Whether or not article dates are displayed.| +|`showEdit`|boolean|`article.showEdit`|Whether or not the link to edit the article content should be displayed.| |`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.| +|`showSummary`|boolean|`list.showSummary`|Whether or not the article summary should be displayed on list pages.| +|`summary`|string|_Auto generated using `summaryLength` (see [site configuration]({{< ref "configuration#site-configuration" >}}))_|When `showSummary` is enabled, this is the Markdown string to be used as the summary for this article.| |`xml`|boolean|`true` unless excluded by `sitemap.excludedKinds`|Whether or not this article is included in the generated `/sitemap.xml` file.| diff --git a/exampleSite/content/docs/getting-started.md b/exampleSite/content/docs/getting-started.md index 487b326b..50f9fc2b 100644 --- a/exampleSite/content/docs/getting-started.md +++ b/exampleSite/content/docs/getting-started.md @@ -34,6 +34,40 @@ The `[author]` configuration determines how the author information is displayed Further detail about these configuration options is covered in the [Configuration]({{< ref "configuration" >}}) section. +## Colour schemes + +Congo ships with a number of colour schemes out of the box. To change the scheme, simply set the `colorScheme` theme parameter. Valid options are `congo` (default), `avocado`, `fire`, `ocean` and `slate`. + +```toml +# config/_default/params.toml + +colorScheme = "congo" +``` + +Congo defines a three-colour palette that is used throughout the theme. Each main colour contains ten shades which are based upon the colours that are included in [Tailwind](https://tailwindcss.com/docs/customizing-colors#color-palette-reference). + +#### Congo (default) + +{{< swatches "#71717a" "#8b5cf6" "#d946ef" >}} + +#### Avocado + +{{< swatches "#78716c" "#84cc16" "#10b981" >}} + +#### Fire + +{{< swatches "#78716c" "#f97316" "#f43f5e" >}} + +#### Ocean + +{{< swatches "#64748b" "#3b82f6" "#06b6d4" >}} + +#### Slate + +{{< swatches "#6B7280" "#6B7280" "#6B7280" >}} + +Although these are the default schemes, you can also create your own. Refer to the [Advanced Customisation]({{< ref "advanced-customisation#colour-schemes" >}}) section for details. + ## Organising content 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. @@ -50,7 +84,13 @@ topic = "topics" This will replace the default _tags_ and _categories_ with _topics_. Refer to the [Hugo Taxonomy docs](https://gohugo.io/content-management/taxonomies/) for more information on naming taxonomies. -When you create a new taxonomy, you will need to adjust the navigation links on the website to point to the new sections: +When you create a new taxonomy, you will need to adjust the navigation links on the website to point to the correct sections. + +## Menus + +Congo has two menus that can be customised to suit the content and layout of your site. The `main` menu appears in the site header and the `footer` menu appears at the bottom of the page just above the copyright notice. + +Both menus are configured in the `menus.toml` file. ```toml # config/_default/menus.toml @@ -64,6 +104,20 @@ When you create a new taxonomy, you will need to adjust the navigation links on name = "Topics" pageRef = "topics" weight = 20 + +[[footer]] + name = "Privacy" + url = "https://external-link" ``` -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]({{< ref "configuration" >}}) section. +The `name` parameter specifies the text that is used in the menu link. You can also optionally provide a `title` which fills the HTML title attribute for the link. + +The `pageRef` parameter allows you to easily reference Hugo content pages and taxonomies. It is the quickest way to configure the menu as you can simply refer to any Hugo content item and it will automatically build the correct link. To link to external URLs, the `url` parameter can be used. + +Menu links will be sorted from lowest to highest `weight`, and then alphabetically by `name`. + +Both menus are completely optional and can be commented out if not required. Use the template provided in the file as a guide. + +## Detailed configuration + +The steps above 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]({{< ref "configuration" >}}) section. diff --git a/exampleSite/content/docs/homepage-layout/index.md b/exampleSite/content/docs/homepage-layout/index.md index 4b570a90..94bff73e 100644 --- a/exampleSite/content/docs/homepage-layout/index.md +++ b/exampleSite/content/docs/homepage-layout/index.md @@ -9,7 +9,7 @@ tags: ["homepage", "layouts", "docs"] 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 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](#recent-articles). ## Page layout @@ -23,10 +23,12 @@ To enable the page layout, set `homepage.layout = "page"` in the `params.toml` c 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. - ![Profile layout](home-profile.jpg) +The author information is provided in the `config.toml` configuration file. Refer to the [Getting Started]({{< ref "getting-started" >}}) and [Site Configuration]({{< ref "configuration#site-configuration" >}}) sections for parameter details. + +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. ## Custom layout @@ -37,7 +39,9 @@ To enable the custom layout, set `homepage.layout = "custom"` in the `params.tom 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. -To include recent articles on the custom layout, use the `recent-articles.html` partial. +To include [recent articles](#recent-articles) on the custom layout, use the `recent-articles.html` partial. + +As an example, the [homepage]({{< ref "/" >}}) on this site uses the custom layout to allow toggling between the profile and page layouts. Visit the [GitHub repo](https://github.com/jpanther/congo/blob/dev/exampleSite/layouts/partials/home/custom.html) to see how it works. ## Recent articles diff --git a/exampleSite/content/docs/installation.md b/exampleSite/content/docs/installation.md index c5ac0959..b376c09e 100644 --- a/exampleSite/content/docs/installation.md +++ b/exampleSite/content/docs/installation.md @@ -101,4 +101,4 @@ config/_default/ 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. +Refer to the [Hugo docs](https://gohugo.io/getting-started/) for more information or continue to the [Getting Started]({{< ref "getting-started" >}}) section to learn more about configuring the theme. diff --git a/exampleSite/content/samples/_index.md b/exampleSite/content/samples/_index.md index 470493b4..fcce5fef 100755 --- a/exampleSite/content/samples/_index.md +++ b/exampleSite/content/samples/_index.md @@ -4,6 +4,7 @@ description: "See what's possible with Congo." cascade: showEdit: false + showSummary: true --- {{< lead >}} @@ -14,6 +15,6 @@ This section contains some demo pages that show how Congo renders different type You can also see an example [taxonomy listing]({{< ref "tags" >}}) page. -_**Sidenote:** This page is just a standard Congo article listing and Hugo has been configured to generate a `samples` content type._ +_**Sidenote:** This page is just a standard Congo article listing and Hugo has been configured to generate a `samples` content type and display article summaries._ --- diff --git a/exampleSite/content/samples/emoji-support.md b/exampleSite/content/samples/emoji-support.md index c4a0b026..e522e6d2 100755 --- a/exampleSite/content/samples/emoji-support.md +++ b/exampleSite/content/samples/emoji-support.md @@ -2,13 +2,12 @@ title: "Emoji Support" date: 2019-03-05 description: "Guide to emoji usage in Hugo" +summary: "πŸ“–πŸžοΈπŸ§—πŸ½πŸͺ‚πŸ‰πŸ§™πŸ½β€β™‚οΈπŸ§šπŸ½πŸ‘Έ" tags: ["emoji", "sample"] --- Emoji can be enabled in a Hugo project in a number of ways. - - The [`emojify`](https://gohugo.io/functions/emojify/) function can be called directly in templates or [Inline Shortcodes](https://gohugo.io/templates/shortcode-templates/#inline-shortcodes). To enable emoji globally, set `enableEmoji` to `true` in your site's [configuration](https://gohugo.io/getting-started/configuration/) and then you can type emoji shorthand codes directly in content files; e.g. diff --git a/exampleSite/content/samples/rich-content.md b/exampleSite/content/samples/rich-content.md index 786de795..9c7c3ee3 100755 --- a/exampleSite/content/samples/rich-content.md +++ b/exampleSite/content/samples/rich-content.md @@ -2,13 +2,12 @@ title: "Rich Content" date: 2019-03-10 description: "A brief description of Hugo Shortcodes" +summary: "This is an _example_ of a **rich** content summary." tags: ["shortcodes", "privacy", "sample"] --- Hugo ships with several [Built-in Shortcodes](https://gohugo.io/content-management/shortcodes/#use-hugos-built-in-shortcodes) for rich content, along with a [Privacy Config](https://gohugo.io/about/hugo-and-gdpr/) and a set of Simple Shortcodes that enable static and no-JS versions of various social media embeds. -## - ## YouTube Privacy Enhanced Shortcode {{< youtube ZJthWmvUzzc >}} diff --git a/exampleSite/content/users.md b/exampleSite/content/users.md index eae73fed..ce2953cc 100644 --- a/exampleSite/content/users.md +++ b/exampleSite/content/users.md @@ -19,5 +19,6 @@ Real websites that are built with Congo. | -------------------------------------------- | ---------------------------- | | [jamespanther.com](https://jamespanther.com) | Personal site - Theme author | | [zekeriyaay.com](https://zekeriyaay.com) | Personal cheat sheets site | +| [srisco.dev](https://srisco.dev) | Personal site | **Congo user?** To add your site to this list, [submit a pull request](https://github.com/jpanther/congo/blob/dev/exampleSite/content/users.md). diff --git a/exampleSite/layouts/shortcodes/swatches.html b/exampleSite/layouts/shortcodes/swatches.html new file mode 100644 index 00000000..322db53e --- /dev/null +++ b/exampleSite/layouts/shortcodes/swatches.html @@ -0,0 +1,14 @@ +
+ + + +
diff --git a/i18n/en.yaml b/i18n/en.yaml index 6052261f..323877b4 100644 --- a/i18n/en.yaml +++ b/i18n/en.yaml @@ -16,7 +16,7 @@ error: 404_description: "It seems that the page you've requested does not exist." footer: - powered_by: "Powered by {{ .Hugo }}" + powered_by: "Powered by {{ .Hugo }} & {{ .Congo }}" list: externalurl_title: "Link to external site" @@ -26,6 +26,7 @@ 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" diff --git a/i18n/zh.yaml b/i18n/zh.yaml index 4d48f9b5..8237c110 100644 --- a/i18n/zh.yaml +++ b/i18n/zh.yaml @@ -15,7 +15,7 @@ error: 404_description: "ζ‚¨θ―·ζ±‚ηš„ι‘΅ι’δΌΌδΉŽδΈε­˜εœ¨γ€‚" footer: - powered_by: "η”± {{ .Hugo }} εΌΊεŠ›ι©±εŠ¨" + powered_by: "η”± {{ .Hugo }} & {{ .Congo }} εΌΊεŠ›ι©±εŠ¨" list: externalurl_title: "ι“ΎζŽ₯εˆ°ε€–ιƒ¨η½‘η«™" diff --git a/layouts/partials/article-link.html b/layouts/partials/article-link.html index 0b576b14..da147bb8 100644 --- a/layouts/partials/article-link.html +++ b/layouts/partials/article-link.html @@ -33,4 +33,9 @@
{{ partial "article-meta.html" . }}
+ {{ if .Params.showSummary | default (.Site.Params.list.showSummary | default false) }} +
+ {{ .Summary | emojify }} +
+ {{ end }} diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 278dfbd2..05b91696 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -1,6 +1,23 @@ -