summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2023-01-17 12:51:46 +0100
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2023-01-17 12:51:46 +0100
commitb661132e0ac651fa229511f05f58554717f4d0d0 (patch)
tree7e1b3ff9ca2f2284809f840c067edc308aa35f52 /docs/README.md
parentd595419031b247d6f15a615f6e70b1956ff8eab1 (diff)
parentef6f101e75256c3bb88a6f1f3b5c1273bf8d7382 (diff)
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md
index 072714a02..730ad5fc8 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -19,6 +19,15 @@ Spelling fixes are most welcomed, and if you want to contribute longer sections
* For example, try to find short snippets that teaches people about the concept. If the example is also useful as-is (copy and paste), then great. Don't list long and similar examples just so people can use them on their sites.
* Hugo has users from all over the world, so easy to understand and [simple English](https://simple.wikipedia.org/wiki/Basic_English) is good.
+
+## Edit the theme
+
+If you want to do docs-related theme changes, the simplest way is to have both `hugoDocs` and `gohugoioTheme` cloned as sibling directories, and then run:
+
+```
+HUGO_MODULE_WORKSPACE=hugo.work hugo server --ignoreVendorPaths "**"
+```
+
## Branches
* The `master` branch is where the site is automatically built from, and is the place to put changes relevant to the current Hugo version.