| Camel K Documentation |
| ===================== |
| |
| == Environment Setup |
| |
| To setup the environment you need to execute the following command once (and every time you change yarn dependencies): |
| |
| ``` |
| yarn install |
| ``` |
| |
| == Local development |
| |
| To build the partial website from the local worktree, execute: |
| |
| ``` |
| yarn build |
| ``` |
| |
| == Build and preview |
| |
| To build the partial website from the local worktree and preview the results, execute: |
| |
| ``` |
| yarn preview |
| ``` |
| |
| == xref check |
| |
| To check the xrefs in the partial site, execute: |
| |
| ``` |
| yarn checks |
| ``` |
| |
| Valid xrefs to parts of the site in other sources will appear as (spurious) errors. |
