From ff665593088f91db78b7f52b0eadddb251969009 Mon Sep 17 00:00:00 2001 From: Yukuro Date: Tue, 2 Jan 2024 21:06:22 +0900 Subject: [PATCH 1/2] fix readme.md for hugo mod --- README.md | 24 +++++++++--------------- 1 file changed, 9 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index ec61dae..21ada37 100644 --- a/README.md +++ b/README.md @@ -44,28 +44,22 @@ Terminal-like theme with selectable color schemes. ## Installation ### Create a new website from scratch +1. Create a website and initialize Hugo Module ```bash hugo new site myportfolio cd myportfolio -git init -git submodule add https://github.com/Yukuro/hugo-theme-shell.git themes/hugo-theme-shell -hugo server -t hugo-theme-shell -w -D +hugo mod init github.com/YOUR_USERNAME/myportfolio ``` - -### Apply to an existing site -```bash -cd myportfolio -git submodule add https://github.com/Yukuro/hugo-theme-shell.git themes/hugo-theme-shell -hugo server -t hugo-theme-shell -w -D +2. Edit `hugo.toml` +```toml +[module] +[[module.imports]] + path = 'github.com/yukuro/hugo-theme-shell' ``` - -#### Note: How to use stable version -After running `git submodule add`, do the following +3. Launch hugo server ```bash -cd themes/hugo-theme-shell -git checkout TAG_FOR_STABLE_VERSION +hugo server -w -D ``` -`TAG_FOR_STABLE_VERSION` : The stable version tag can be found on the [release page of my repository](https://github.com/Yukuro/hugo-theme-shell/releases) (i.e. `v0.1.5`, `v0.1.4` ...etc). ### How to use theme hugo-theme-shell supports the [Mayccoll/Gogh](https://github.com/Mayccoll/Gogh) theme From 4bfa860e33a0e9af04ead2331cbb06315a8e9043 Mon Sep 17 00:00:00 2001 From: Yukuro Date: Tue, 2 Jan 2024 21:08:11 +0900 Subject: [PATCH 2/2] fix dead link in readme.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 21ada37..5625d71 100644 --- a/README.md +++ b/README.md @@ -63,7 +63,7 @@ hugo server -w -D ### How to use theme hugo-theme-shell supports the [Mayccoll/Gogh](https://github.com/Mayccoll/Gogh) theme -1. Choose a Goph theme : you can choose a theme [here](https://mayccoll.github.io/Gogh/). +1. Choose a Goph theme : you can choose a theme [here](https://gogh-co.github.io/Gogh/). 2. Copy the name of the theme you selected 3. Configure your config.toml as follows ```toml