diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index 0ab9f2b..0000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,57 +0,0 @@ -## [v1.4](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.4) - 2025-04-21 - -* ENHANCEMENTS - * Add optional license text and AI opt-out-text to footer (#40) - -## [v1.3.3](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.3.3) - 2025-03-03 - -* ENHANCEMENTS - * Set Referrer-Policy Meta-Header (#39) - -## [v1.3.2](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.3.2) - 2025-02-19 - -* ENHANCEMENTS - * Added missing styling for ol elements in articles class (#38) - -## [v1.3.1](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.3.1) - 2025-02-11 - -* BUGFIXES - * Fix to eliminate the rest of Flickr API in layouts/partials/custom_image_handler.html (#37) - -## [v1.3](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.3) - 2025-02-11 - -* ENHANCEMENTS - * Eliminate Flickr because of cookieless browsing experience (#35) - * Change font to "Inter" locally (#36) - -## [v1.2](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.2) - 2025-02-11 - -* WONTFIX - * Fix path to icon android-chrome-192x192.png when served on subpath (#34) -* ENHANCEMENTS - * Move repository to new public organization (#33) - * Updated lightbox2 to version 2.11.5 (#32) - * Every external library should be served locally (#6) - * Serve font files locally (#31) - -## [v1.1.2](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.1.2) - 2025-02-11 - -* BUGFIXES - * Problem with categories path, which is absolute (#30) - -## [v1.1.1](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.1.1) - 2025-02-11 - -* BUGFIXES - * Multilingual date formatting (#29) - -## [v1.1](https://git.hadan-it.com/stiebke/hugo-internet-weblog/releases/tag/v1.1) - 2025-01-29 - -* BUGFIXES - * Fix not valid RSS-Feed (#27) - * Eliminate ´s in specific file (#7) -* ENHANCEMENTS - * Configurable statuspage-link in footer (#28) - * Rework Umami Integration (#12) - * Update documentation (#10) - * Rework favicon integration (#5) - * Create demo page repository (#4) diff --git a/LICENSE b/LICENSE.md similarity index 95% rename from LICENSE rename to LICENSE.md index b791041..a463681 100644 --- a/LICENSE +++ b/LICENSE.md @@ -1,7 +1,6 @@ The MIT License (MIT) Copyright (c) 2016 Josh Johnson -Enhancements: Copyright (c) 2025 Stephan Hadan Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in diff --git a/README.md b/README.md index ee23c42..b53c1b9 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,11 @@ `internet-weblog` is a minimalistic (and a bit responsive) Hugo theme that offers a traditional blog mixed with a microblog and a photoblog. It also offers the ability to do simple link posts that link to a remote page. It was ported from a theme made for Octopress. -The theme features unique layouts for displaying all posts sorted by year, and support for partials to customize style and javascript loaded. +The theme features a customizable bio-section and flickr-based photo stream in it's footer, unique layouts for displaying all posts sorted by year, and support for partials to customize style and javascript loaded. -To see more, [check out a sample site which is rendered with this theme](https://preview.hadan-it.com/hugo-internet-weblog-demo/) and see it's [configuration on my Forgejo instance](https://git.hadan-it.com/public/hugo-internet-weblog-demo). +To see more, [check out my blog which is rendered with this theme](http://jnjosh.com) and see it's [configuration on Github](https://github.com/jnjosh/jnjosh.com). -![internet-weblog showing a Micropost.](https://git.hadan-it.com/public/hugo-internet-weblog/raw/branch/main/images/screenshot.png) +![internet-weblog showing a Micropost.](https://git.hadan-it.com/stiebke/hugo-internet-weblog/raw/branch/main/images/screenshot.png) ## Contents @@ -35,14 +35,14 @@ To see more, [check out a sample site which is rendered with this theme](https:/ Inside the folder of your Hugo site run: $ mkdir themes - $ git submodule add https://git.hadan-it.com/public/hugo-internet-weblog.git themes/internet-weblog - $ echo "theme = 'internet-weblog'" >> hugo.toml + $ cd themes + $ git clone https://github.com/jnjosh/internet-weblog.git -For more information read the official [setup guide](https://gohugo.io/installation/) for Hugo. +For more information read the official [setup guide](//gohugo.io/overview/installing/) for Hugo. ## Getting Started -There are a few concepts this theme employs to make a personal blog. It's important to read this as you may not see what you expect upon launching. Since this theme is built to be a personal blog it opts for some simplifications like using the ["Section Menu for the Lazy Blogger"](https://gohugo.io/content-management/menus/#section-menu-for-the-lazy-blogger) option in Hugo for displaying a simple menu. It assumes you want to call your blog posts `posts` and organizes them as such. For example, creating a new post (or micropost, or photopost) with Hugo would require you typing: +There are a few concepts this theme employs to make a personal blog. It's important to read this as you may not see what you expect upon launching. Since this theme is built to be a personal blog it opts for some simplifications like using the ["Section Menu for the Lazy Blogger"](https://gohugo.io/extras/menus/#section-menu-for-the-lazy-blogger) option in Hugo for displaying a simple menu. It assumes you want to call your blog posts `posts` and organizes them as such. For example, creating a new post (or micropost, or photopost) with Hugo would require you typing: ``` $ hugo new posts/my-new-post.md @@ -60,13 +60,13 @@ It also assumes you want to display links to your sections of content (`posts`, The theme works with other content types, but posts work best when grouped under `posts`. When using the `posts` (_note that it is plural_) content type you'll have a customized list page sorted by year and the default list page. Here's an example: -![Custom List Page sorted by Year](https://git.hadan-it.com/public/hugo-internet-weblog/raw/branch/main/images/posts.png) +![Custom List Page sorted by Year](https://git.hadan-it.com/stiebke/hugo-internet-weblog/raw/branch/main/images/posts.png) **Recommendation:** Organize your blog posts under the `posts` directory. #### How to configure the menu in the blog's navigation -As mentioned above, this theme takes a simplistic approach to menus. In fact, it doesn't really support custom menus opting to just use Hugo's `main` menu. Because it uses the ["Section Menu for the Lazy Blogger"](https://gohugo.io/content-management/menus/#section-menu-for-the-lazy-blogger) you'll need to make one change to your `hugo.toml` file. Add **main** as the `SectionPagesMenu`. +As mentioned above, this theme takes a simplistic approach to menus. In fact, it doesn't really support custom menus opting to just use Hugo's `main` menu. Because it uses the ["Section Menu for the Lazy Blogger"](https://gohugo.io/extras/menus/#section-menu-for-the-lazy-blogger) you'll need to make one change to your `config.toml` file. Add **main** as the `SectionPagesMenu`. ``` SectionPagesMenu = "main" @@ -74,14 +74,14 @@ SectionPagesMenu = "main" Because of this, your individual posts don't need to organize themselves into menu groupings. Everything is assumed to be grouped at the top level. One exception to this is if you want to add a custom page to the root of the menu. In this case you would want to add `menu: main` to your page's Front Matter. -You can control which menu items get an RSS icon and link by adding the `RSSSections` list to your Params section of your `hugo.toml`: +You can control which menu items get an RSS icon and link by adding the `RSSSections` list to your Params section of your `config.toml`: ``` [params] RSSSections = [ "Posts", "Microposts", "Photos" ] ``` -You can then control the name and weight of these menus in your `hugo.toml` by adding a section for each menu item you'd like to display: +You can then control the name and weight of these menus in your `config.toml` by adding a section for each menu item you'd like to display: ``` [[menu.main]] @@ -91,16 +91,16 @@ You can then control the name and weight of these menus in your `hugo.toml` by a url = "/posts/" ``` -If you aren't sure of how this should look, see how [reaktionsfaehig.net uses this in it's hugo.toml](https://git.hadan-it.com/web/reaktionsfaehig.net/src/branch/main/hugo.toml). +If you aren't sure of how this should look, see how [jnjosh.com uses this in it's config.toml](https://github.com/jnjosh/jnjosh.com/blob/main/config.toml). -**Recommendation:** Add `SectionPagesMenu` to your `hugo.toml` file. +**Recommendation:** Add `SectionPagesMenu` to your `config.toml` file. **Recommendation:** Don't set a `menu` in your post's Front Matter unless you want it to display on the navigation. -**Recommendation:** Customize the menus that get an RSS icon by adding the `RSSSections` parameter to your `hugo.toml` file. -**Recommendation:** Configure the menu items by adding `menu.main` sections to your `hugo.toml` file. +**Recommendation:** Customize the menus that get an RSS icon by adding the `RSSSections` parameter to your `config.toml` file. +**Recommendation:** Configure the menu items by adding `menu.main` sections to your `config.toml` file. #### Defining yourself as the Author -It looks like most themes use the `author` variable to add something simple like your name. This theme uses more structured data about you and requires an `[params.author]` section. The details of what is affected by each property is defined below in the variables section, but you should add this section to your `hugo.toml`: +It looks like most themes use the `author` variable to add something simple like your name. This theme uses more structured data about you and requires an `[params.author]` section. The details of what is affected by each property is defined below in the variables section, but you should add this section to your `config.toml`: ``` [params.author] @@ -112,7 +112,7 @@ It looks like most themes use the `author` variable to add something simple like FlickrID = "" ``` -**Recommendation:** Don't use the `author` variable, use the above `[params.author]` section in your `hugo.toml`. +**Recommendation:** Don't use the `author` variable, use the above `[params.author]` section in your `config.toml`. #### Customizing the Bio Section, 404 page, javascript, or stylesheets @@ -132,7 +132,7 @@ externalurl = "http://kickstarter.com" These posts are rendered slightly different with an → to signify that it is remote. -![External URL](https://git.hadan-it.com/public/hugo-internet-weblog/raw/branch/main/images/linkpost.png) +![External URL](https://git.hadan-it.com/stiebke/hugo-internet-weblog/raw/branch/main/images/linkpost.png) #### Specifying a featured image for social media @@ -144,7 +144,7 @@ feature: "assets/posts/20240219/image.jpg" #### Preferred Dark Appearance -If you want to enable a dark appearance, there is limited support for that. Currently, setting the `EnablePreferredDarkAppearance` param to true in your `hugo.toml` file will enable it in an automatic state—if the system is using dark mode. +If you want to enable a dark appearance, there is limited support for that. Currently, setting the `EnablePreferredDarkAppearance` param to true in your config.toml file will enable it in an automatic state—if the system is using dark mode. ### Variables @@ -158,27 +158,17 @@ If you want to enable a dark appearance, there is limited support for that. Curr | `[params.author]` - `LastName` | Your last name | Not really. It is used in some places to identify you as the author. | | `[params.author]` - `AboutPage` | `/about` or `http://about.othersite.com` | Only if you want an about page. This is exposed to allow you to link to an external about page as well. If you have a local page it can just be something relative. | | `[params.author]` - `Location` | `Your City` | No. If set, this is added to the Copyright in the footer so you can give some love to your hometown. | +| `[params.author]` - `FlickrID` | `Your Flickr ID` | No. The footer shows your photo stream from flickr. If you don't set it, nothing will be displayed. | | `[params]` - `Description` | `Describe your site` | No. If set, this is added to your pages metadata. | | `[params]` - `ShowCopyright` | `true` or `false` | No. If true, Copyright text will be added to the footer. | | `[params]` - `EnablePreferredDarkAppearance` | `true` or `false` | No. If true, The viewers system dark mode is respected switching to a dark appearance. | | `[params]` - `RSSEnabled` | `true` or `false` | No. If true, RSS pages will be generated. | -| `[params]` - `RSSSections` | `[ "Posts", "Microposts", "Photos" ]` | If you want RSS links in the menu, yes. These strings need to be the display name of the section where you want to have an RSS icon displayed. ![rss](https://git.hadan-it.com/public/hugo-internet-weblog/raw/branch/main/images/rss.png) | +| `[params]` - `RSSSections` | `[ "Posts", "Microposts", "Photos" ]` | If you want RSS links in the menu, yes. These strings need to be the display name of the section where you want to have an RSS icon displayed. ![rss](https://git.hadan-it.com/stiebke/hugo-internet-weblog/raw/branch/main/images/rss.png) | | `[params]` - `RSSMicropostTitles` | `true` or `false` | No. If false, Microposts RSS feeds will not have the title in included posts. If not present or true, nothing happens. | | `[params]` - `YearlyMicroposts` | `true` or `false` | No. If true, Microposts will have a page with a yearly grouping just like the posts. If not present or false, the default of not having a micropost yearly grouping is applied. | | `[params]` - `SummarizeMicroposts` | `true` or `false` | No. If true, Microposts will be summarized in the main list just like posts with a continue reading link. If not present or false, the default of not summarizing microposts is applied. | -| `[params]`- `umamienabled` | `true` or `false` | No. If true and the the following umami-parameters are set, activate umami website analytics. | -| `[params]`- `umamiurl` | `Your Umami-URL`| No. i.e. `https://analytics.example.com/`. Please add the trailing slash at the end. | -| `[params]`- `umamisrihash` | `SRI hash` | No. Generate your SRI hash for your complete Umami-URL (incl. script.js). You can do this here: [https://www.srihash.org/](https://www.srihash.org/). | -| `[params]`- `umamiid` | `Umami Website ID` | No. Add Your Umami-Website ID to this variable | -| `[params]`- `statuspageenabled` | `true` or `false` | No. If true an all parameters are set a link to your status page is shown in the page_footer. | -| `[params]`- `statuspage` | `Your Statuspage-URL`| No. i.e. `https://status.example.com`. | -| `[params]`- `statuspagename` | `Name your Statuspage` | No. Set a specific name for your statuspage in de page_footer. | -| `[params]`- `showlicense` | `true` or `false` | No. Show license in footer. | -| `[params]`- `license` | `Name your license` | No. i.e. `CC BY NC SA 4.0` | -| `[params]`- `licensepage` | `Your license-url` | No. i.e. `https://example.com/license` | -| `[params]`- `tdmurl` | `Your AI/ML-Opt-Out-URL` | No. i.e. `https://example.com/imprint/` | -Here is an example `hugo.toml`: +Here is an example `config.toml`: ``` baseurl = "http://mysite.com/" @@ -194,23 +184,13 @@ SectionPagesMenu = "main" LastName = "Johnson" AboutPage = "/about" Location = "Durham, NC" + FlickrID = "87151163@N00" [params] Description = "This is my blog, read it and enjoy." ShowCopyright = true RSSEnabled = true RSSSections = [ "Posts", "Microposts", "Photos" ] - umamienabled = true - umamiurl = "https://analytics.example.com" - umamisrihash = "xyz" - umamiid = "xxxxxxxxxxxxxxxxxxx-yyyyyyyyyy-zzzzzzzzzzzzz" - statuspageenabled = true - statuspage = "https://status.example.com/status/preview-demo" - statuspagename = "Statusseite" - showlicense = true - licensepage = "https://example.com/license/" - tdmurl = "https://example.com/imprint/" - license= "CC BY NC SA 4.0" [taxonomies] tag = "tags" @@ -276,14 +256,13 @@ This theme makes use of the following 3rd Party Libraries. ## License -This theme is released under MIT. For more information, please see the [License](https://git.hadan-it.com/public/hugo-internet-weblog/src/branch/main/LICENSE). +This theme is released under MIT. For more information, please see the [License](http://jnjosh.mit-license.org). ## Contact This is the first theme I've made for Hugo, so I'm sure I've done some things wrong or assumed too much. If you have ideas or things that should be fixed, please let me know. - [Josh Johnson](http://jnjosh.com) [@jnjosh](https://mastodon.social/@jnjosh) -- Enhancements: [Stephan Hadan](https://stephan.hadan.de) [@stiebke](https://freiburg.social/@stiebke) --- diff --git a/changelog.yml b/changelog.yml deleted file mode 100644 index dc13b8b..0000000 --- a/changelog.yml +++ /dev/null @@ -1,23 +0,0 @@ -# The full repository name -repo: stiebke/hugo-internet-weblog - -# Service type (gitea or github) -service: gitea - -# Base URL for Gitea instance if using gitea service type (optional) -# Default: https://gitea.com -base-url: https://git.hadan-it.com - -# Changelog groups and which labeled PRs to add to each group -groups: - - - name: BUGFIXES - labels: - - bug - - - name: ENHANCEMENTS - labels: - - enhancement - -# regex indicating which labels to skip for the changelog -skip-labels: skip-changelog|backport\/.+ diff --git a/layouts/partials/bio.html b/layouts/partials/bio.html index a8a06b3..775884c 100644 --- a/layouts/partials/bio.html +++ b/layouts/partials/bio.html @@ -1,2 +1,2 @@ Here you can place a short bio about yourself. Place a `bio.html` file in your -project directory under `layouts/partials`. That will override this message. +project directory under `layout/partials`. That will override this message. diff --git a/layouts/partials/custom_image_handler.html b/layouts/partials/custom_image_handler.html index f7f6edf..65fdbd3 100644 --- a/layouts/partials/custom_image_handler.html +++ b/layouts/partials/custom_image_handler.html @@ -1,4 +1,4 @@ - + diff --git a/layouts/partials/page_footer.html b/layouts/partials/page_footer.html index 3551822..3b96ecc 100644 --- a/layouts/partials/page_footer.html +++ b/layouts/partials/page_footer.html @@ -1,27 +1,24 @@ \ No newline at end of file + diff --git a/layouts/partials/page_header.html b/layouts/partials/page_header.html index 2a92297..a8b0300 100644 --- a/layouts/partials/page_header.html +++ b/layouts/partials/page_header.html @@ -1,6 +1,6 @@