summaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorIan Lewis <ianmlewis@gmail.com>2019-11-14 13:32:40 -0500
committerIan Lewis <ianmlewis@gmail.com>2019-11-14 13:32:40 -0500
commitb94ef2075a78c3d7c6e479f152e48ab85db0f84e (patch)
tree10af0ebc8635f2cbbab5fa88d60ae879ce1e76c8 /README.md
parenta2b055de52cb90180ad57c26119fe72e61d70494 (diff)
Added info on styles to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 44dfa9ab6..465377549 100644
--- a/README.md
+++ b/README.md
@@ -61,6 +61,27 @@ go run main.go
Access the site at http://localhost:8080
+## 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.