From 2382c7531bd7045d0b7623f6218440fad04b08dc Mon Sep 17 00:00:00 2001 From: panr Date: Sat, 5 Sep 2020 18:24:03 +0200 Subject: [PATCH] Update README. --- README.md | 18 +++++++++++++----- 1 file changed, 13 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 07e17ba..9af3fa4 100644 --- a/README.md +++ b/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 -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. -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 $ cd themes/hello-friend @@ -243,12 +243,20 @@ Otherwise, if you really want to edit the theme, you need to install Node depend $ yarn ``` -and finally, to run webpack in watch mode: +After you modified the files you can run webpack in watch mode: -``` +```bash $ yarn dev ``` +or rebuild theme + +```bash +$ yarn build +``` + +To see the changes (remember to restart `hugo server`). + ## Found a 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.