minikube's documentation is in [Markdown](https://www.markdownguide.org/cheat-sheet/), and generated using the following tools:
*[Hugo](https://gohugo.io)
*[Docsy](https://www.docsy.dev)
In production, the minikube website is served using [Netlify](http://netlify.com/)
## Local documentation website
To serve documentation pages locally, clone the `minikube` repository and run:
`make site`
NOTE: On Windows, our site currently causes Hugo to `panic`.
## Lint
We recommend installing [markdownlint](https://github.com/markdownlint/markdownlint) to find issues with your markdown file. Once installed, you can use this handy target:
`make mdlint`
## Style Guidelines
We follow the [Kubernetes Documentation Style Guide](https://kubernetes.io/docs/contribute/style/style-guide/)
## Linking between documents
For compile-time checking of links, use one of the following forms to link between documentation pages:
```go-html-template
{{</* ref "document.md" */>}}
{{</* ref "#anchor" */>}}
{{</* ref "document.md#anchor" */>}}
{{</* ref "/blog/my-post" */>}}
{{</* ref "/blog/my-post.md" */>}}
{{</* relref "document.md" */>}}
{{</* relref "#anchor" */>}}
{{</* relref "document.md#anchor" */>}}
```
For more information, please see [Hugo: Links and Cross References](https://gohugo.io/content-management/cross-references/)
## Pull Request Previews
When reviewing documentation PR's, look for the test that says:
