mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2025-02-24 23:26:21 +00:00
42 lines
1 KiB
Markdown
42 lines
1 KiB
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 3](https://docusaurus.io/), a modern static website generator.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
pnpm install
|
|
```
|
|
|
|
## Before your first build
|
|
Before running `build` or `start` commands for the first time, you need to build plugins in docs/plugins/woodpecker-plugins:
|
|
|
|
```bash
|
|
cd docs/plugins/woodpecker-plugins
|
|
pnpm build
|
|
```
|
|
|
|
## Build
|
|
## Local Development
|
|
|
|
```bash
|
|
pnpm 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.
|
|
|
|
```bash
|
|
pnpm build
|
|
```
|
|
|
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
|
|
|
## Deployment
|
|
|
|
Deployment happen via [CI](https://github.com/woodpecker-ci/woodpecker/blob/d59fdb4602bfdd0d00078716ba61b05c02cbd1af/.woodpecker/docs.yml#L8-L30) to [woodpecker-ci.org](https://woodpecker-ci.org).
|
|
|
|
To manually build the website and push it exec:
|
|
|
|
```sh
|
|
GIT_USER=woodpecker-bot USE_SSH=true DEPLOYMENT_BRANCH=main pnpm deploy
|
|
```
|