From 5fc1e03a7af2021d08c581d648c9082b3c48eb19 Mon Sep 17 00:00:00 2001 From: Jan Raasch <425211+janraasch@users.noreply.github.com> Date: Wed, 15 Mar 2023 16:26:38 +0100 Subject: docs: no email support ❌😅😁 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 -- 1 file changed, 2 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 32be8b1..066fbec 100644 --- a/README.md +++ b/README.md @@ -67,8 +67,6 @@ Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you ## Issues / Feedback / Contributing Please use [GitHub issues](https://github.com/janraasch/hugo-bearblog/issues) and [Pull Requests](https://github.com/janraasch/hugo-bearblog/pulls). -If you do not have a GitHub-account, please hit me up via e-mail (see [janraasch.com](https://www.janraasch.com)). - ## Special Thanks 🎁 A special thank you goes out to [Herman](https://herman.bearblog.dev), for creating the original [ʕ•ᴥ•ʔ Bear Blog](https://bearblog.dev/). -- cgit v1.2.3 From dec11203de4ad0877f4cb0fec4c0305c4fccca8e Mon Sep 17 00:00:00 2001 From: Martijn Engler Date: Tue, 23 Jan 2024 10:28:44 +0100 Subject: Use hugo.toml instead of config.toml (#74) * Use hugo.toml instead of config.toml Use the file hugo.toml in both the README.md and the exampleSite, since Hugo will look for this file first. The current instructions (using config.toml) in a new Hugo site (that has a hugo.toml-file) means that the site doesn't work, or the theme is not activated. Note that this is a breaking change for sites running on older versions. (But v0.110.0 was released almost a year ago.) Relevant Hugo commit: https://github.com/gohugoio/hugo/commit/f38a2fbd2e4de7f095a833b448cb8bc053955ce2 * Require `hugo v0.110.0` > Make hugo.toml the new config.toml see https://github.com/gohugoio/hugo/releases/tag/v0.110.0 --------- Co-authored-by: Jan Raasch <425211+janraasch@users.noreply.github.com> --- README.md | 6 +++--- exampleSite/config.toml | 52 ------------------------------------------------- exampleSite/hugo.toml | 52 +++++++++++++++++++++++++++++++++++++++++++++++++ theme.toml | 2 +- 4 files changed, 56 insertions(+), 56 deletions(-) delete mode 100644 exampleSite/config.toml create mode 100644 exampleSite/hugo.toml (limited to 'README.md') diff --git a/README.md b/README.md index 066fbec..6c2304f 100644 --- a/README.md +++ b/README.md @@ -24,13 +24,13 @@ If you already have a Hugo site on your machine, you can simply add this theme v git submodule add https://github.com/janraasch/hugo-bearblog.git themes/hugo-bearblog ``` -Then, adjust the `config.toml` as detailed below. +Then, adjust the `hugo.toml` as detailed below. For more information, read the official [setup guide][hugo-setup-guide] of Hugo. -## Adjust configuration / config.toml +## Adjust configuration / hugo.toml -Please check out the [config.toml](https://github.com/janraasch/hugo-bearblog/blob/master/exampleSite/config.toml) included in the [exampleSite](https://github.com/janraasch/hugo-bearblog/tree/master/exampleSite) of this theme. +Please check out the [hugo.toml](https://github.com/janraasch/hugo-bearblog/blob/master/exampleSite/hugo.toml) included in the [exampleSite](https://github.com/janraasch/hugo-bearblog/tree/master/exampleSite) of this theme. ## Content & structure diff --git a/exampleSite/config.toml b/exampleSite/config.toml deleted file mode 100644 index d67e845..0000000 --- a/exampleSite/config.toml +++ /dev/null @@ -1,52 +0,0 @@ -# Base URL used when generating links to your pages -# Set to the URL for your site -baseURL = "https://example.com" - -# The name of this wonderful theme ;-). -theme = 'hugo-bearblog' - -# Basic metadata configuration for your blog. -title = "Hugo ʕ•ᴥ•ʔ Bear Blog" -author = "Jane Doe" -copyright = "Copyright © 2020, Jane Doe." -languageCode = "en-US" - -# Generate a nice robots.txt for SEO -enableRobotsTXT = true - -# Generate "Bearblog"-like URLs !only!, see https://bearblog.dev/. -disableKinds = ["taxonomy"] -ignoreErrors = ["error-disable-taxonomy"] -[permalinks] - blog = "/:slug/" - tags = "/blog/:slug" - -[params] - # The "description" of your website. This is used in the meta data of your generated html. - description = "Hugo + Bear = :heart:" - - # The path to your "favicon". This should be a square (at least 32px x 32px) png-file. - # Hint: It's good practise to also put a "favicon.ico"-file into your "static"-folder. - favicon = "images/favicon.png" - - # These "images" are used for the structured data templates. This will show up, when - # services like Twitter or Slack want to generate a preview of a link to your site. - # See https://gohugo.io/templates/internal#twitter-cards and - # https://gohugo.io/templates/internal#open-graph. - images = ["images/share.png"] - - # Another "title" :-). This one is used as the site_name on the Hugo's internal - # opengraph structured data template. - # See https://ogp.me/ and https://gohugo.io/templates/internal#open-graph. - title = "Hugo ʕ•ᴥ•ʔ Bear" - - # This theme will, by default, inject a made-with-line at the bottom of the page. - # You can turn it off, but we would really appreciate if you don’t :-). - # hideMadeWithLine = true - - # By default, this theme displays dates with a format like "02 Jan, 2006", but - # you can customize it by setting the `dateFormat` param in your site's config - # file. See [Hugo's Format function docs](https://gohugo.io/functions/format/) - # for details. An example TOML config that uses [ISO - # 8601](https://en.wikipedia.org/wiki/ISO_8601) format: - # dateFormat = "2006-01-02" diff --git a/exampleSite/hugo.toml b/exampleSite/hugo.toml new file mode 100644 index 0000000..d67e845 --- /dev/null +++ b/exampleSite/hugo.toml @@ -0,0 +1,52 @@ +# Base URL used when generating links to your pages +# Set to the URL for your site +baseURL = "https://example.com" + +# The name of this wonderful theme ;-). +theme = 'hugo-bearblog' + +# Basic metadata configuration for your blog. +title = "Hugo ʕ•ᴥ•ʔ Bear Blog" +author = "Jane Doe" +copyright = "Copyright © 2020, Jane Doe." +languageCode = "en-US" + +# Generate a nice robots.txt for SEO +enableRobotsTXT = true + +# Generate "Bearblog"-like URLs !only!, see https://bearblog.dev/. +disableKinds = ["taxonomy"] +ignoreErrors = ["error-disable-taxonomy"] +[permalinks] + blog = "/:slug/" + tags = "/blog/:slug" + +[params] + # The "description" of your website. This is used in the meta data of your generated html. + description = "Hugo + Bear = :heart:" + + # The path to your "favicon". This should be a square (at least 32px x 32px) png-file. + # Hint: It's good practise to also put a "favicon.ico"-file into your "static"-folder. + favicon = "images/favicon.png" + + # These "images" are used for the structured data templates. This will show up, when + # services like Twitter or Slack want to generate a preview of a link to your site. + # See https://gohugo.io/templates/internal#twitter-cards and + # https://gohugo.io/templates/internal#open-graph. + images = ["images/share.png"] + + # Another "title" :-). This one is used as the site_name on the Hugo's internal + # opengraph structured data template. + # See https://ogp.me/ and https://gohugo.io/templates/internal#open-graph. + title = "Hugo ʕ•ᴥ•ʔ Bear" + + # This theme will, by default, inject a made-with-line at the bottom of the page. + # You can turn it off, but we would really appreciate if you don’t :-). + # hideMadeWithLine = true + + # By default, this theme displays dates with a format like "02 Jan, 2006", but + # you can customize it by setting the `dateFormat` param in your site's config + # file. See [Hugo's Format function docs](https://gohugo.io/functions/format/) + # for details. An example TOML config that uses [ISO + # 8601](https://en.wikipedia.org/wiki/ISO_8601) format: + # dateFormat = "2006-01-02" diff --git a/theme.toml b/theme.toml index 47199ab..066e67a 100644 --- a/theme.toml +++ b/theme.toml @@ -9,7 +9,7 @@ homepage = "https://github.com/janraasch/hugo-bearblog" demosite = "https://janraasch.github.io/hugo-bearblog/" tags = ["blog", "responsive", "minimal", "seo", "clean", "simple", "light", "minimalist", "mobile", "fast", "white", "minimalistic", "reading", "dark mode"] features = ["favicon", "seo", "no stylesheets", "no javascript", "rss", "dark mode"] -min_version = "0.73.0" +min_version = "v0.110.0" # https://gohugo.io/content-management/taxonomies#default-taxonomies # https://gohugo.io/templates/taxonomy-templates/#example-list-tags-in-a-single-page-template # https://gohugo.io/templates/taxonomy-templates/#example-list-all-site-tags -- cgit v1.2.3 From fab37cf385a8bcab05951b8e2e851c0ecdc441fe Mon Sep 17 00:00:00 2001 From: Jan Raasch <425211+janraasch@users.noreply.github.com> Date: Tue, 20 Feb 2024 15:47:14 +0100 Subject: Add »Development«-section on README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit This is mostly a note to self 📝😁😇 --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) (limited to 'README.md') diff --git a/README.md b/README.md index 6c2304f..ab0a75e 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ When the user's browser is running »dark mode«, the dark color scheme will be If you already have a Hugo site on your machine, you can simply add this theme via -``` +```bash git submodule add https://github.com/janraasch/hugo-bearblog.git themes/hugo-bearblog ``` @@ -48,7 +48,7 @@ The contents of the `index`-page may be changed by editing your `content/_index. You can add **a new page** via running -``` +```bash hugo new my-new-page.md ``` @@ -56,7 +56,7 @@ hugo new my-new-page.md You can add **a new blog-post** via running -``` +```bash hugo new blog/my-new-post.md ``` @@ -67,6 +67,13 @@ Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you ## Issues / Feedback / Contributing Please use [GitHub issues](https://github.com/janraasch/hugo-bearblog/issues) and [Pull Requests](https://github.com/janraasch/hugo-bearblog/pulls). +## Development +Run the `exampleSite` locally via + +```bash +hugo server --source ./exampleSite --themesDir ../.. +``` + ## Special Thanks 🎁 A special thank you goes out to [Herman](https://herman.bearblog.dev), for creating the original [ʕ•ᴥ•ʔ Bear Blog](https://bearblog.dev/). -- cgit v1.2.3