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.

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

Add VitePress instructions to BUILD.md #2675

Merged
31 changes: 31 additions & 0 deletions BUILD.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,37 @@ The `docs` target uses the `ghcr.io/kanisterio/docker-sphinx` public image to
generate the HTML documents and store them in your local `/docs/_build/html`
folder.

## New Documentation

We have started experimenting, and will soon fully transition, to using
[VitePress](https://vitepress.dev/) to generate Kanister documentation.
This requires the documentation files to be written in
[Markdown](https://www.markdownguide.org/), along with some
[extensions](https://vitepress.dev/guide/markdown).

This new documentation system offers a live-dev server that will dynamically
render Markdown documentation files as you are making changes to them on your
local machine/branch.
To start this development server, place yourself in the `new_docs` folder, then
run the following commands:

```sh
pnpm install
pnpm run docs:dev
```

To render/build the docs locally (it will generate static assets, like HTML
pages, Javascript/CSS files, etc.), use this command:
```sh
pnpm run docs:build
```

To start a local webserver that you can use to preview the documentation that
has been rendered by the command above, use this command:
```sh
pnpm run docs:preview
```

## New Blueprints

If you have new blueprints that you think will benefit the community, feel free
Expand Down
Loading