Skip to content

Commit f0cacec

Browse files
committed
add info about updating docsy theme
1 parent da59aad commit f0cacec

File tree

1 file changed

+17
-2
lines changed

1 file changed

+17
-2
lines changed

README.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,27 @@ This repository contains the assets required to build the [Kubernetes website an
88

99
See the [official Hugo documentation](https://gohugo.io/getting-started/installing/) for Hugo installation instructions. Make sure to install the Hugo extended version specified by the `HUGO_VERSION` environment variable in the [`netlify.toml`](netlify.toml#L10) file.
1010

11-
To run the website locally when you have Hugo installed:
11+
Before building the site, clone the Kubernetes website repository:
1212

1313
```bash
1414
git clone https://github.com/kubernetes/website.git
1515
cd website
16-
git submodule update --init --recursive
16+
git submodule update --init --recursive --depth 1
17+
```
18+
19+
**Note:** The Kubernetes website deploys the [Docsy Hugo theme](https://github.com/google/docsy#readme).
20+
If you have not updated your website repository, the `website/themes/docsy` directory is empty. The site cannot build
21+
without a local copy of the theme.
22+
23+
Update the website theme:
24+
25+
```bash
26+
git submodule update --init --recursive --depth 1
27+
```
28+
29+
To build and test the site locally, run:
30+
31+
```bash
1732
hugo server --buildFuture
1833
```
1934

0 commit comments

Comments
 (0)