summaryrefslogtreecommitdiffstats
path: root/docs/README.md
diff options
context:
space:
mode:
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.