woodpecker/docs/README.md

# Website

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

### Installation

```
$ pnpm install
```

### Local Development

```
$ 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

```
$ 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
```
[Docs] Migrate docs framework to Docusaurus (#282) - Replace mkdocs with docosaurus (improved menu structure, ...) - Structure docs into `Usage` and `Server Setup / Administration` - Update favicon - Create new pipeline-syntax page with all options and links to more detailed docs if available - Add ci to publish to `woodpecker-ci.github.io` - Deploy docs preview to surge for review - Update start-page Co-authored-by: 6543 <6543@obermui.de> 2021-09-11 15:10:32 +00:00			`# Website`

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

			`### Installation`

			```
Replace yarn with pnpm (#1240) Should resolve startup issues in gitpod and be a lot faster 🚀 2022-10-08 14:15:07 +00:00			`$ pnpm install`
[Docs] Migrate docs framework to Docusaurus (#282) - Replace mkdocs with docosaurus (improved menu structure, ...) - Structure docs into `Usage` and `Server Setup / Administration` - Update favicon - Create new pipeline-syntax page with all options and links to more detailed docs if available - Add ci to publish to `woodpecker-ci.github.io` - Deploy docs preview to surge for review - Update start-page Co-authored-by: 6543 <6543@obermui.de> 2021-09-11 15:10:32 +00:00			```

			`### Local Development`

			```
Replace yarn with pnpm (#1240) Should resolve startup issues in gitpod and be a lot faster 🚀 2022-10-08 14:15:07 +00:00			`$ pnpm start`
[Docs] Migrate docs framework to Docusaurus (#282) - Replace mkdocs with docosaurus (improved menu structure, ...) - Structure docs into `Usage` and `Server Setup / Administration` - Update favicon - Create new pipeline-syntax page with all options and links to more detailed docs if available - Add ci to publish to `woodpecker-ci.github.io` - Deploy docs preview to surge for review - Update start-page Co-authored-by: 6543 <6543@obermui.de> 2021-09-11 15:10:32 +00:00			```

			`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`

			```
Replace yarn with pnpm (#1240) Should resolve startup issues in gitpod and be a lot faster 🚀 2022-10-08 14:15:07 +00:00			`$ pnpm build`
[Docs] Migrate docs framework to Docusaurus (#282) - Replace mkdocs with docosaurus (improved menu structure, ...) - Structure docs into `Usage` and `Server Setup / Administration` - Update favicon - Create new pipeline-syntax page with all options and links to more detailed docs if available - Add ci to publish to `woodpecker-ci.github.io` - Deploy docs preview to surge for review - Update start-page Co-authored-by: 6543 <6543@obermui.de> 2021-09-11 15:10:32 +00:00			```

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

			`### Deployment`

Update links to woodpecker-ci.org (#445) 2021-10-14 16:13:57 +00:00			`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).`
[Docs] Migrate docs framework to Docusaurus (#282) - Replace mkdocs with docosaurus (improved menu structure, ...) - Structure docs into `Usage` and `Server Setup / Administration` - Update favicon - Create new pipeline-syntax page with all options and links to more detailed docs if available - Add ci to publish to `woodpecker-ci.github.io` - Deploy docs preview to surge for review - Update start-page Co-authored-by: 6543 <6543@obermui.de> 2021-09-11 15:10:32 +00:00
Improve administration docs (#307) * Improve administration docs * Correct docker image names * Update docs README Co-authored-by: 6543 <6543@obermui.de> 2021-09-16 16:50:53 +00:00			`To manually build the website and push it exec:`

			```sh
Replace yarn with pnpm (#1240) Should resolve startup issues in gitpod and be a lot faster 🚀 2022-10-08 14:15:07 +00:00			`GIT_USER=woodpecker-bot USE_SSH=true DEPLOYMENT_BRANCH=master pnpm deploy`
Improve administration docs (#307) * Improve administration docs * Correct docker image names * Update docs README Co-authored-by: 6543 <6543@obermui.de> 2021-09-16 16:50:53 +00:00			```