Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance Readability with Markdown Formatting Improvements To README.md #47430

Merged
merged 2 commits into from
Aug 25, 2024
Merged

Enhance Readability with Markdown Formatting Improvements To README.md #47430

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d5a5702
Update README.md
ywh555hhh Aug 11, 2024
88b24ba
Merge branch 'main' of https://github.com/ywh555hhh/website
ywh555hhh Aug 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,14 @@ cd website
The Kubernetes website uses the [Docsy Hugo theme](https://github.com/google/docsy#readme). Even if you plan to run the website in a container, we strongly recommend pulling in the submodule and other development dependencies by running the following:

### Windows

```powershell
# fetch submodule dependencies
git submodule update --init --recursive --depth 1
```

### Linux / other Unix

```bash
# fetch submodule dependencies
make module-init
Expand All @@ -62,11 +64,14 @@ Open up your browser to <http://localhost:1313> to view the website. As you make
To install dependencies, deploy and test the site locally, run:

- For macOS and Linux

```bash
npm ci
make serve
```

- For Windows (PowerShell)

```powershell
npm ci
hugo.exe server --buildFuture --environment development
Expand Down