# weave-gitops-docs

**Repository Path**: mirrors_weaveworks/weave-gitops-docs

## Basic Information

- **Project Name**: weave-gitops-docs
- **Description**: GitOps documentation repo
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-07-07
- **Last Updated**: 2026-09-12

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Website

This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.

## Installation

```console
yarn install
```

## Local Development

Set a fake Algolia API key to pass validation errors:

```shell
export ALGOLIA_API_KEY=fakekey
```

```console
yarn start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

## Build

```console
yarn build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.

## Deployment

Deployment happens automatically (once the tests pass) upon merging to the default branch: see [.github/workflows/documentation.yml](.github/workflows/documentation.yml) for config.