summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/README.md b/README.md
index f8081c88a..c16221350 100644
--- a/README.md
+++ b/README.md
@@ -56,3 +56,32 @@ content changes:
```
make server
```
+
+## Updating Styles
+
+If you want to update style on the website you can do this by updating
+templates or CSS for the website. Check out the [Hugo
+documentation](https://gohugo.io/documentation/) for info on hugo templating.
+Check out the [Docsy documentation](https://www.docsy.dev/docs/) for info on
+the Docsy theme.
+
+### Custom templates, partials, and shortcodes
+
+Custom templates, including partials and shortcodes, should go under the
+[layouts/](layouts) directory.
+
+## Custom CSS
+
+Custom CSS styles should go into the
+[_styles_project.scss](assets/scss/_styles_project.scss) file.
+
+If you need to override or create variables used in scss styles, update the
+[_variables_project.scss](assets/scss/_variables_project.scss) file.
+
+## Troubleshooting
+
+#### I get errors when building the website.
+
+If you get the following errors you should check that you have the "extended"
+version of Hugo. This is the version of hugo named "hugo\_extended" on the
+[releases page](https://github.com/gohugoio/hugo/releases). \ No newline at end of file