thomasjsn/hugo-theme-hello-friend
1
0
Fork 0
mirror of https://github.com/thomasjsn/hugo-theme-hello-friend.git synced 2024-11-14 20:35:07 +01:00
Code Issues Projects Releases Wiki Activity

make it easier to copy code from README

Browse Source
This commit is contained in:
panr 2021-11-01 19:15:31 +01:00
parent df780f1256
commit fa808517f2
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -99,13 +99,13 @@ You can download the theme manually by going to [https://github.com/panr/hugo-th
You can also clone it directly to your Hugo folder: You can also clone it directly to your Hugo folder:
```bash ```bash
$ git clone https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend git clone https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend
``` ```
If you don't want to make any radical changes, it's the best option, because you can get new updates when they are available. To do so, include it as a git submodule: If you don't want to make any radical changes, it's the best option, because you can get new updates when they are available. To do so, include it as a git submodule:
```bash ```bash
$ git submodule add https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend git submodule add https://github.com/panr/hugo-theme-hello-friend.git themes/hello-friend
``` ```
⚠️ **The theme needs at least Hugo version 0.74.x**. ⚠️ **The theme needs at least Hugo version 0.74.x**.
@ -115,7 +115,7 @@ $ git submodule add https://github.com/panr/hugo-theme-hello-friend.git themes/h
From your Hugo root directory run: From your Hugo root directory run:
``` ```
$ hugo server -t hello-friend hugo server -t hello-friend
``` ```
and go to `localhost:1313` in your browser. From now on all the changes you make will go live, so you don't need to refresh your browser every single time. and go to `localhost:1313` in your browser. From now on all the changes you make will go live, so you don't need to refresh your browser every single time.
@ -233,27 +233,27 @@ To change something directly in the theme, you have to go to `themes/hello-frien
First, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory): First, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory):
```bash ```bash
$ cd themes/hello-friend cd themes/hello-friend
``` ```
then run: then run:
```bash ```bash
$ npm install npm install
$ npm i yarn npm i yarn
$ yarn yarn
``` ```
After you modified the files you can run webpack in watch mode: After you modified the files you can run webpack in watch mode:
```bash ```bash
$ yarn dev yarn dev
``` ```
or rebuild theme or rebuild theme
```bash ```bash
$ yarn build yarn build
``` ```
To see the changes (remember to restart `hugo server`). To see the changes (remember to restart `hugo server`).