woodpecker/docs/README.md
Dhanu Saputra e9fc5ebd0e
Docs: make sure shell examples can be copied (#1670)
close #1656

---------

Co-authored-by: 6543 <6543@obermui.de>
Co-authored-by: qwerty287 <80460567+qwerty287@users.noreply.github.com>
2023-03-24 18:18:14 +01:00

35 lines
864 B
Markdown

# Website
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
### Installation
```bash
pnpm install
```
### 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.
### Build
```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=master pnpm deploy
```