Merge pull request #490 from mirceanton/bug-486-defaults-not-ok

📚 Fix default config to match the description from the docs site
This commit is contained in:
Nuno Coração 2023-01-30 21:51:06 +00:00 committed by GitHub
commit e873cef9fd
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 94 additions and 92 deletions

View file

@ -9,8 +9,8 @@ defaultContentLanguage = "en"
# pluralizeListTitles = "true" # hugo function useful for non-english languages, find out more in https://gohugo.io/getting-started/configuration/#pluralizelisttitles # pluralizeListTitles = "true" # hugo function useful for non-english languages, find out more in https://gohugo.io/getting-started/configuration/#pluralizelisttitles
enableRobotsTXT = true enableRobotsTXT = true
paginate = 20 paginate = 10
summaryLength = 30 summaryLength = 0
buildDrafts = false buildDrafts = false
buildFuture = false buildFuture = false

View file

@ -7,16 +7,16 @@ rtl = false
title = "Blowfish" title = "Blowfish"
# logo = "img/logo.png" # logo = "img/logo.png"
description = "My awesome website" # description = "My awesome website"
# copyright = "Copy, _right?_ :thinking_face:" # copyright = "Copy, _right?_ :thinking_face:"
dateFormat = "2 January 2006" dateFormat = "2 January 2006"
[author] # [author]
name = "Your name here" # name = "Your name here"
image = "img/blowfish_logo.png" # image = "img/blowfish_logo.png"
headline = "I'm only human" # headline = "I'm only human"
bio = "A little bit about you" # bio = "A little bit about you"
# links = [ # links = [
# { email = "mailto:hello@your_domain.com" }, # { email = "mailto:hello@your_domain.com" },
# { link = "https://link-to-some-website.com/" }, # { link = "https://link-to-some-website.com/" },

View file

@ -9,13 +9,13 @@ colorScheme = "blowfish"
defaultAppearance = "light" # valid options: light or dark defaultAppearance = "light" # valid options: light or dark
autoSwitchAppearance = true autoSwitchAppearance = true
enableSearch = true enableSearch = false
enableCodeCopy = true enableCodeCopy = false
# mainSections = ["section1", "section2"] # mainSections = ["section1", "section2"]
# robots = "" # robots = ""
# disableImageOptimization = false disableImageOptimization = false
# defaultBackgroundImage = "IMAGE.jpg" # used as default for background images # defaultBackgroundImage = "IMAGE.jpg" # used as default for background images
@ -27,10 +27,10 @@ enableCodeCopy = true
layout = "basic" # valid options: basic, fixed layout = "basic" # valid options: basic, fixed
[footer] [footer]
# showMenu = true showMenu = true
showCopyright = true showCopyright = true
showThemeAttribution = true showThemeAttribution = true
showAppearanceSwitcher = true showAppearanceSwitcher = false
showScrollToTop = true showScrollToTop = true
[homepage] [homepage]
@ -46,17 +46,17 @@ enableCodeCopy = true
[article] [article]
showDate = true showDate = true
#showViews = true showViews = false
#showLikes = true showLikes = false
showDateUpdated = false showDateUpdated = false
showAuthor = true showAuthor = true
showHero = true showHero = false
heroStyle = "basic" # valid options: basic, big, background, thumbAndBackground # heroStyle = "basic" # valid options: basic, big, background, thumbAndBackground
layoutBackgroundBlur = false # only used when heroStyle equals background or thumbAndBackground layoutBackgroundBlur = true # only used when heroStyle equals background or thumbAndBackground
layoutBackgroundHeaderSpace = true # only used when heroStyle equals background layoutBackgroundHeaderSpace = true # only used when heroStyle equals background
showBreadcrumbs = true showBreadcrumbs = false
showDraftLabel = true showDraftLabel = true
showEdit = true showEdit = false
# editURL = "https://github.com/username/repo/" # editURL = "https://github.com/username/repo/"
editAppendPath = true editAppendPath = true
seriesOpened = false seriesOpened = false
@ -64,22 +64,22 @@ enableCodeCopy = true
showPagination = true showPagination = true
invertPagination = false invertPagination = false
showReadingTime = true showReadingTime = true
showTableOfContents = true showTableOfContents = false
showTaxonomies = false showTaxonomies = false
showAuthorsBadges = false showAuthorsBadges = false
showWordCount = true showWordCount = true
showSummary = true showSummary = true
sharingLinks = [ "linkedin", "twitter", "reddit", "pinterest", "facebook", "email"] # sharingLinks = [ "linkedin", "twitter", "reddit", "pinterest", "facebook", "email"]
[list] [list]
#showHero = true showHero = false
# heroStyle = "background" # valid options: basic, big, background, thumbAndBackground # heroStyle = "background" # valid options: basic, big, background, thumbAndBackground
#layoutBackgroundBlur = true # only used when heroStyle equals background or thumbAndBackground layoutBackgroundBlur = true # only used when heroStyle equals background or thumbAndBackground
#layoutBackgroundHeaderSpace = true # only used when heroStyle equals background layoutBackgroundHeaderSpace = true # only used when heroStyle equals background
showBreadcrumbs = false showBreadcrumbs = false
showSummary = false showSummary = false
#showViews = true showViews = false
#showLikes = true showLikes = false
showTableOfContents = false showTableOfContents = false
showCards = false showCards = false
groupByYear = true groupByYear = true
@ -88,28 +88,28 @@ enableCodeCopy = true
constrainItemsWidth = false constrainItemsWidth = false
[sitemap] [sitemap]
excludedKinds = [] excludedKinds = ["taxonomy", "term"]
[taxonomy] [taxonomy]
showTermCount = true showTermCount = true
#showHero = true showHero = false
# heroStyle = "background" # valid options: basic, big, background, thumbAndBackground # heroStyle = "background" # valid options: basic, big, background, thumbAndBackground
showBreadcrumbs = false showBreadcrumbs = false
#showViews = false showViews = false
#showLikes = false showLikes = false
#showTableOfContents = true showTableOfContents = false
#cardView = false cardView = false
[term] [term]
#showHero = true showHero = false
# heroStyle = "background" # valid options: basic, big, background, thumbAndBackground # heroStyle = "background" # valid options: basic, big, background, thumbAndBackground
showBreadcrumbs = false showBreadcrumbs = false
#showViews = false showViews = false
#showLikes = false showLikes = false
#showTableOfContents = true showTableOfContents = true
#groupByYear = false groupByYear = false
#cardViewScreenWidth = false cardView = false
#cardView = false cardViewScreenWidth = false
[firebase] [firebase]
# apiKey = "XXXXXX" # apiKey = "XXXXXX"

View file

@ -143,7 +143,7 @@ Many of the article defaults here can be overridden on a per article basis by sp
| `disableImageZoom` | `false` | Disables image zoom feature across all the images in the site. | | `disableImageZoom` | `false` | Disables image zoom feature across all the images in the site. |
| `disableImageOptimization` | `false` | Disables image resize and optimization features across all the images in the site. | | `disableImageOptimization` | `false` | Disables image resize and optimization features across all the images in the site. |
| `defaultBackgroundImage` | _Not set_ | Default background image for both `background` homepage layout and `background` hero style | | `defaultBackgroundImage` | _Not set_ | Default background image for both `background` homepage layout and `background` hero style |
| `defaultBackgroundImage` | _Not set_ | Marks menu entries in the main manu when selected | | `defaultBackgrouclearndImage` | _Not set_ | Marks menu entries in the main manu when selected |
| `smartTOC` | _Not set_ | Activate smart Table of Contents, items in view will be highlighted. | | `smartTOC` | _Not set_ | Activate smart Table of Contents, items in view will be highlighted. |
| `smartTOCHideUnfocusedChildren` | _Not set_ | When smart Table of Contents is turned on, this will hide deeper levels of the table when they are not in focus. | | `smartTOCHideUnfocusedChildren` | _Not set_ | When smart Table of Contents is turned on, this will hide deeper levels of the table when they are not in focus. |
@ -169,8 +169,8 @@ Many of the article defaults here can be overridden on a per article basis by sp
| `homepage.homepageImage` | _Not set_ | Image to be used in `hero` and `card` layouts. Refer to the [Homepage Layout]({{< ref "homepage-layout" >}}) section for more details. | | `homepage.homepageImage` | _Not set_ | Image to be used in `hero` and `card` layouts. Refer to the [Homepage Layout]({{< ref "homepage-layout" >}}) section for more details. |
| `homepage.showRecent` | `false` | Whether or not to display the recent articles list on the homepage. | | `homepage.showRecent` | `false` | Whether or not to display the recent articles list on the homepage. |
| `homepage.showRecentItems` | 5 | How many articles to display if showRecent is true. If variable is set to 0 or if it isn't defined the system will default to 5 articles. | | `homepage.showRecentItems` | 5 | How many articles to display if showRecent is true. If variable is set to 0 or if it isn't defined the system will default to 5 articles. |
| `homepage.showMoreLink` | 'false' | Wether or not to display a show more link at the end of your posts that takes the user to a predefined place. | | `homepage.showMoreLink` | `false` | Wether or not to display a show more link at the end of your posts that takes the user to a predefined place. |
| `homepage.showMoreLinkDest` | '/posts' | The destination of the show more button. | | `homepage.showMoreLinkDest` | `/posts` | The destination of the show more button. |
| `homepage.cardView` | `false` | Display recent articles as a gallery of cards. | | `homepage.cardView` | `false` | Display recent articles as a gallery of cards. |
| `homepage.cardViewScreenWidth` | `false` | Enhance the width of the recent articles card gallery to take the full width available. | | `homepage.cardViewScreenWidth` | `false` | Enhance the width of the recent articles card gallery to take the full width available. |
| `homepage.layoutBackgroundBlur` | `false` | Makes the background image in the homepage layout blur with the scroll | | `homepage.layoutBackgroundBlur` | `false` | Makes the background image in the homepage layout blur with the scroll |
@ -202,6 +202,7 @@ Many of the article defaults here can be overridden on a per article basis by sp
| `article.showAuthorsBadges` | `false` | Whether the `authors` taxonomies are are displayed in the article or list header. This requires the setup of `multiple authors` and the `authors` taxonomy. Check [this page]({{< ref "multi-author" >}}) for more details on how to configure that feature. | | `article.showAuthorsBadges` | `false` | Whether the `authors` taxonomies are are displayed in the article or list header. This requires the setup of `multiple authors` and the `authors` taxonomy. Check [this page]({{< ref "multi-author" >}}) for more details on how to configure that feature. |
| `article.showWordCount` | `false` | Whether or not article word counts are displayed. | | `article.showWordCount` | `false` | Whether or not article word counts are displayed. |
| `article.showComments` | `false` | Whether or not the [comments partial]({{< ref "partials#comments" >}}) is included after the article footer. | | `article.showComments` | `false` | Whether or not the [comments partial]({{< ref "partials#comments" >}}) is included after the article footer. |
| `article.showSummary` | `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). |
| `article.sharingLinks` | _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. | | `article.sharingLinks` | _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 ### List
@ -222,6 +223,7 @@ Many of the article defaults here can be overridden on a per article basis by sp
| `list.cardView` | `false` | Display lists as a gallery of cards. | | `list.cardView` | `false` | Display lists as a gallery of cards. |
| `list.cardViewScreenWidth` | `false` | Enhance the width of card galleries in lists to take the full width available. | | `list.cardViewScreenWidth` | `false` | Enhance the width of card galleries in lists to take the full width available. |
| `list.constrainItemsWidth` | `false` | Limit item width to `prose` to increase readability. Useful when no feature images are available. | | `list.constrainItemsWidth` | `false` | Limit item width to `prose` to increase readability. Useful when no feature images are available. |
| `list.showTableOfContents` | `false` | Whether or not the table of contents is displayed on articles. |
### Sitemap ### Sitemap