kubernetes
/
minikube
mirror of https://github.com/kubernetes/minikube.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
minikube/site
History
minikube-bot 63bbbd1a52 Update auto-generated docs and translations 2021-12-10 23:19:10 +00:00
..
assets wrap the installation section into a blue card 2021-05-18 01:07:45 -04:00
content/en Update auto-generated docs and translations 2021-12-10 23:19:10 +00:00
layouts cleans up the ingress-dns docs 2021-11-08 03:32:29 -05:00
static add time-to-k8s benchmark for 2021-11-05 16:43:29 +00:00
themes Update Docsy theme to latest version 2020-12-01 02:02:08 +00:00
.gitignore Fix unit tests and go tempalte block 2020-01-08 17:08:11 -08:00
.hugo_build.lock docs: add details about app output for /docs/start 2021-10-25 19:13:48 +05:30
README.md updated site/README.md 2021-07-23 14:05:49 +02:00
config.toml icon 2021-07-07 19:10:51 -04:00
package-lock.json site npm audit fix 2020-04-08 14:15:15 -07:00
package.json Switch hugo themes from whisper to docsy 2019-07-19 19:04:51 -07:00

README.md

Docsy is a Hugo theme for technical documentation sites, providing easy site navigation, structure, and more. This Minikube project uses the Docsy theme for Minikube Website.

You can find detailed theme instructions in the Docsy user guide: https://docsydocs.netlify.com/docs/

Running the website locally

Clone the minikube project fork with option --recurse-submodules --depth 1 to download and update submodule dependencies.

git clone --recurse-submodules --depth 1 https://github.com/kubernetes/minikube.git  # replace path with your github fork of minikube 
cd minikube/site
hugo server # to server site locally

The theme is included as a Git submodule:

▶ git submodule
 2536303cad19991c673037f4f16332075141364a themes/docsy (2536303)

If you want to do SCSS edits and want to publish these, you need to install PostCSS (not needed for hugo server):

npm install

Common Issues

Start building sites …
hugo v0.86.0+extended darwin/amd64 BuildDate=unknown
Error: Error building site: "/minikube/site/content/en/docs/contrib/releasing/binaries.md:64:1": failed to extract shortcode: template for shortcode "alert" not found
Built in 667 ms

This indicates the submodules are not upated. Please run the following command to fix.
git submodule update --init --recursive