diff options
| author | Jake Wiesler <jakewiesler@gmail.com> | 2020-07-14 05:45:35 +0300 |
|---|---|---|
| committer | Jake Wiesler <jakewiesler@gmail.com> | 2020-07-14 05:45:35 +0300 |
| commit | ce541dc46f60f38a5ca60ff9e77ef249186384f1 (patch) | |
| tree | 89cafb68ebce97a6cfdbaf4f1bcaa3c2d9f814cc | |
| parent | 2e2f558a819a0b82499b613bb5a7e1e3462e9576 (diff) | |
feat: include build:example scriptupdate-contributing
| -rw-r--r-- | CONTRIBUTING.md | 8 | ||||
| -rw-r--r-- | package.json | 1 |
2 files changed, 8 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 diff --git a/package.json b/package.json index 7f85cca..5e8eceb 100644 --- a/package.json +++ b/package.json @@ -6,6 +6,7 @@ "license": "MIT", "scripts": { "develop": "hugo server -s ./exampleSite/", + "build:example": "hugo -s ./exampleSite/", "format": "prettier ./ --write" }, "husky": { |