mirror of
https://github.com/woodpecker-ci/woodpecker.git
synced 2024-06-16 12:20:45 +00:00
2bfeb9e1fa
* Improve administration docs * Correct docker image names * Update docs README Co-authored-by: 6543 <6543@obermui.de>
36 lines
862 B
Markdown
36 lines
862 B
Markdown
# Website
|
|
|
|
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
|
|
|
### Installation
|
|
|
|
```
|
|
$ yarn
|
|
```
|
|
|
|
### Local Development
|
|
|
|
```
|
|
$ 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
|
|
|
|
```
|
|
$ yarn 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.github.io](https://woodpecker-ci.github.io).
|
|
|
|
To manually build the website and push it exec:
|
|
|
|
```sh
|
|
GIT_USER=woodpecker-bot USE_SSH=true DEPLOYMENT_BRANCH=master yarn deploy
|
|
```
|