mirror of
https://github.com/thomasjsn/hugo-theme-hello-friend.git
synced 2024-11-14 12:25:07 +01:00
Update README.
This commit is contained in:
parent
46a294805b
commit
2382c7531b
18
README.md
18
README.md
@ -225,11 +225,11 @@ In a post's front matter you have to add `hideReadMore` param set to `true`. Thi
|
|||||||
|
|
||||||
## How to (safely) edit the theme <a id="how-to-edit" />
|
## How to (safely) edit the theme <a id="how-to-edit" />
|
||||||
|
|
||||||
To change something in the theme, you have to go to `themes/hello-friend` and modify the files.
|
|
||||||
|
|
||||||
If you have to override only some of the styles, you can do this easily by adding `static/style.css` in your root directory and point things you want to change.
|
If you have to override only some of the styles, you can do this easily by adding `static/style.css` in your root directory and point things you want to change.
|
||||||
|
|
||||||
Otherwise, if you really want to edit the theme, you need to install Node dependencies. To do so, go to the theme directory (from your Hugo root directory):
|
To change something directly in the theme, you have to go to `themes/hello-friend` and modify the files.
|
||||||
|
|
||||||
|
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
|
||||||
@ -243,12 +243,20 @@ Otherwise, if you really want to edit the theme, you need to install Node depend
|
|||||||
$ yarn
|
$ yarn
|
||||||
```
|
```
|
||||||
|
|
||||||
and finally, to run webpack in watch mode:
|
After you modified the files you can run webpack in watch mode:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
$ yarn dev
|
$ yarn dev
|
||||||
```
|
```
|
||||||
|
|
||||||
|
or rebuild theme
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ yarn build
|
||||||
|
```
|
||||||
|
|
||||||
|
To see the changes (remember to restart `hugo server`).
|
||||||
|
|
||||||
## Found a bug? <a id="bug" />
|
## Found a bug? <a id="bug" />
|
||||||
|
|
||||||
If you spot any bugs, please use [Issue Tracker](https://github.com/panr/hugo-theme-hello-friend/issues) or create a new [Pull Request](https://github.com/panr/hugo-theme-hello-friend/pulls) to fix the issue.
|
If you spot any bugs, please use [Issue Tracker](https://github.com/panr/hugo-theme-hello-friend/issues) or create a new [Pull Request](https://github.com/panr/hugo-theme-hello-friend/pulls) to fix the issue.
|
||||||
|
Loading…
Reference in New Issue
Block a user