Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions .github/workflows/deploy-gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout (tutorials)
uses: actions/checkout@v3
uses: actions/checkout@v6
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: Checkout (theme)
uses: actions/checkout@v3
uses: actions/checkout@v6
with:
repository: MunifTanjim/minimo
ref: v2.9.0
repository: falkmielke/minimo
ref: update_202605
path: themes/minimo

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
uses: peaceiris/actions-hugo@32c7754570a8edd0ae33352fae4a8448f23858e9 #v3.1.0
with:
hugo-version: '0.88.1'
hugo-version: '0.161.1'
# extended: true

- name: Build
Expand All @@ -39,7 +39,7 @@ jobs:
run: node themes/minimo/scripts/generate-search-index-lunr.js

- name: Deploy 🚀
uses: JamesIves/github-pages-deploy-action@4.0.0
uses: JamesIves/github-pages-deploy-action@d92aa235d04922e8f08b40ce78cc5442fcfbfa2f #v4.8.0
with:
branch: gh-pages
folder: public
14 changes: 7 additions & 7 deletions .github/workflows/generate-artifact-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,23 +8,23 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout (tutorials)
uses: actions/checkout@v3
uses: actions/checkout@v6
with:
ref: ${{ github.event.pull_request.head.sha }}
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- name: Checkout (theme)
uses: actions/checkout@v3
uses: actions/checkout@v6
with:
repository: MunifTanjim/minimo
ref: v2.9.0
repository: falkmielke/minimo
ref: update_202605
path: themes/minimo

- name: Setup Hugo
uses: peaceiris/actions-hugo@v2
uses: peaceiris/actions-hugo@32c7754570a8edd0ae33352fae4a8448f23858e9 #v3.1.0
with:
hugo-version: '0.88.1'
hugo-version: '0.161.1'
# extended: true

- name: Build
Expand All @@ -38,7 +38,7 @@ jobs:
run: node themes/minimo/scripts/generate-search-index-lunr.js

- name: Archive built site to an artifact
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@v7
with:
name: pr-${{ env.PR_NUMBER }}-inbo-tutorials-website
path: public
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/remove_old_artifact.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:

steps:
- name: Remove old artifacts
uses: c-hive/gha-remove-artifacts@v1
uses: c-hive/gha-remove-artifacts@44fc7acaf1b3d0987da0e8d4707a989d80e9554b #v1.4.0
with:
age: '1 days'
skip-recent: 5
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,17 @@ The technology used to create the website is [Hugo](https://gohugo.io/), a stati

1. [Install hugo](https://gohugo.io/getting-started/installing/)
2. Clone the tutorials repository
3. In the cloned tutorials directory, install the theme with `git clone https://github.com/MunifTanjim/minimo.git --branch v2.9.0 themes/minimo`
4. Build and serve the site with `hugo server`
3. In the cloned tutorials directory, install the theme[^1] with `git clone https://github.com/MunifTanjim/minimo.git themes/minimo`
4. Build and serve the site
a) with `hugo server` OR
b) for debugging, with `hugo -D` and then serving manually `python -m http.server 8887 --bind localhost --directory <tutorials>/public/`

[^1]: The `minimo` theme seems unmaintained; a (temporary?) fork with fixes of hugo deprecation warnings is available [here](https://github.com/falkmielke/minimo/tree/update_202605).


For more information, see [Hugo's getting started documentation](https://gohugo.io/getting-started/usage/).


### Customizing the theme

The tutorials website makes use of the Hugo theme [minimo](https://themes.gohugo.io/minimo/). This theme is not included in the repository, but [downloaded by GitHub pages](https://github.com/inbo/tutorials/blob/262f305ef66fd4fc46ef7b2a9dce36cd2ad3e0d9/.github/workflows/deploy-gh-pages.yml#L18-L23) at build time. This avoids clutter and changes to the theme itself. To customize the theme:
Expand All @@ -48,4 +54,4 @@ For more information, see the [Hugo theme customization documentation](https://g

## License

[Creative Commons Attribution](https://creativecommons.org/licenses/by/4.0/) for [content](content) / [MIT License](https://github.com/inbo/tutorials/blob/master/LICENSE) for source code.
[Creative Commons Attribution](https://creativecommons.org/licenses/by/4.0/) for [content](content) / [MIT License](https://github.com/inbo/tutorials/blob/master/LICENSE) for source code.
6 changes: 3 additions & 3 deletions config.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
theme = "minimo"
languageCode = "en-us"
locale = "en-us"
title = "INBO Tutorials"

ignoreFiles = ["\\.Rmd$", "\\.Rmarkdown$", "\\.qmd$", "_cache$", "\\.db$", "\\.csv$", "\\.sqlite$", "\\.geojson$"]
Expand All @@ -12,7 +12,7 @@ copyright = ""
disqusShortname = ""
googleAnalytics = ""

Paginate = 1000
pagination.pagerSize = 1000
preserveTaxonomyNames = true

enableRobotsTXT = true # generate robots.txt
Expand Down Expand Up @@ -146,7 +146,7 @@ hrefTargetBlank = true
# edit this block for your own language
[languages.en]
lang = "en"
languageName = "English"
label = "English"
weight = 1

[markup]
Expand Down
2 changes: 1 addition & 1 deletion layouts/partials/entry/meta/edit-page.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
{{ end }}

{{ with .Site.Params.githublink.GithubEditLink }}
<a href='{{ . }}{{ $.Scratch.Get "FilePath" }}'> {{- partial "svg/icons" "github" -}} Improve this page</a>
<a href='{{ . }}{{ $.Scratch.Get "FilePath" }}'> {{- partial "svg/icon" "github" -}} Improve this page</a>
{{ end }}

{{ end }}
Expand Down
4 changes: 2 additions & 2 deletions layouts/partials/widgets/recent_posts.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{{- $defaultConfig := .Site.Data.config.default.widgets.recent_posts -}}
{{- $configData := ( or .Site.Data.config.widgets.recent_posts $defaultConfig ) -}}
{{- $defaultConfig := hugo.Data.config.default.widgets.recent_posts -}}
{{- $configData := ( or hugo.Data.config.widgets.recent_posts $defaultConfig ) -}}
{{- $lang := .Site.Language.Lang -}}
{{- $config := ( ( index $configData $lang ) | default $configData ) -}}

Expand Down