nishiki/hugo-theme-relearn
1
0
Fork 0
mirror of https://github.com/McShelby/hugo-theme-relearn.git synced 2025-03-20 16:15:09 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add semver info and repo orga #1062

Browse source
This commit is contained in:
Sören Weber 2025-03-19 21:52:12 +01:00
parent e2e7446705
commit 35d29a198f
No known key found for this signature in database
GPG key ID: BEC6D55545451B6D
3 changed files with 24 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
docs/content/introduction/quickstart/_index.en.md
View file

@ -7,6 +7,9 @@ weight = 1
Here's how to start your new website. If you're new to Hugo, we recommend learning more about it in its excellent [starter's guide](https://gohugo.io/getting-started/).
> [!note]
> This quickstart is not meant for a production setup. In production you always want to use specific versions of the theme and Hugo. See the [upgrade page](introduction/upgrade) to learn how to obtain a specific version of the theme.
## Install Hugo
Download and install Hugo {{% badge color="fuchsia" icon="fa-fw fab fa-hackerrank" title=" " %}}0.126.0{{% /badge %}} or newer for your operating system [following the instructions](https://gohugo.io/installation/).

22
docs/content/introduction/upgrade/_index.en.md
View file

@ -11,6 +11,24 @@ The [releasenotes of the theme](introduction/releasenotes) mention if a newer ve
Note, that it is only necessary to upgrade if you are experiencing fixed bugs or want to use new features. It is perfectly fine to stay with arbitrary old versions of Hugo and the theme if everything works for you.
## Semver
Recent releases of the theme follow the [semver standard](https://semver.org/).
## Theme Repo Organization
The `main` branch of the source code repo contains all versions with the development version at the HEAD. This means, pulling from the `main` branch may give you a beta version.
As this is not suitable for production, the repository contains stable tags for each released version in the form of `7.2.1`.
In addition, the repository contains floating tags for
- the latest patch level release of a minor version in the form of `7.2.x`
- the latest minor level release of a major version in the form of `7.x`
- the latest major version in the form of `x`
Choose a tag that best fits your needs.
## Planning the Upgrade
Depending on your previously used version of Hugo and the theme, you might need to upgrade files of your project.
@ -43,11 +61,11 @@ Remove the old version of the theme by removing the `themes/hugo-theme-relearn`
Download the .zip archive of a certain version of the theme and unzip it into the `themes/hugo-theme-relearn` directory
Eg. to upgrade to version 7.2.1 download from [https://github.com/McShelby/hugo-theme-relearn/releases/tag/7.2.1](https://github.com/McShelby/hugo-theme-relearn/releases/tag/7.2.1)
Eg. to upgrade to version 7.2.1 download from [https://github.com/McShelby/hugo-theme-relearn/releases/tag/7.2.1](https://github.com/McShelby/hugo-theme-relearn/releases/tag/7.2.1)
### Use Hugo's Module System
Upgrade the Relearn theme using [Hugo's module system](https://gohugo.io/hugo-modules/use-modules/#upgrade-one-module) to a certain version.
Upgrade the Relearn theme using [Hugo's module system](https://gohugo.io/hugo-modules/use-modules/#update-one-module) to a certain version.
Eg. to upgrade to version 7.2.1

2
layouts/partials/version.txt
View file

@ -1 +1 @@
7.5.0+75d9bc2b2ef443f15cd428a046ca249dcde58131
7.5.0+e2e744670505d811052087baa4b08325d777bf9b