diff options
| author | Jake Wiesler <jakewiesler@gmail.com> | 2020-07-14 17:15:14 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-14 17:15:14 +0300 |
| commit | e78e45840e58acd18cce128d6736c723cbb83f71 (patch) | |
| tree | fc008400f0612e9177027f9cd2a1cad407c5faea /CONTRIBUTING.md | |
| parent | a2bcfde240e20bb68766d898de54baf2908c64a1 (diff) | |
feat: include build:example script (#77)
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e03a7d9..27976c4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,7 +31,13 @@ Runs prettier on the entire project directory. ## Assets The `assets/` directory is where you can write JS and SCSS, which get processed -into CSS files before being placed in the `static/` directory. +into CSS files before being placed in the `static/` directory. + +### Making `scss` changes + +If you make a change to a source `scss` file in `assets/scss`, you will need to make sure that you rebuild the `exampleSite/resources/_gen/assets/` directory to reflect the change in the demo site, else the demo's styles will become stale. + +If you are running `yarn develop`, `hugo` will pick up these changes by default. You can also run `yarn build:example`, which will trigger a one-time rebuild of the example site. From there, commit the updated `resources/_gen` directory to version control. ## Questions |