Skip to content
This repository has been archived by the owner on Sep 1, 2024. It is now read-only.

Commit

Permalink
Merge pull request #58 from Yukuro/fix/readme.md
Browse files Browse the repository at this point in the history
Fix Readme.md
  • Loading branch information
Yukuro authored Jan 2, 2024
2 parents 595ce31 + 4bfa860 commit 98acb2b
Showing 1 changed file with 10 additions and 16 deletions.
26 changes: 10 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,32 +44,26 @@ 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
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
Expand Down

0 comments on commit 98acb2b

Please sign in to comment.