woodpecker/docs
2023-07-10 23:53:02 +02:00
..
docs Add option to read grpc-secret from file (#1972) 2023-07-10 23:53:02 +02:00
plugins/woodpecker-plugins Add Kubernetes and Dockle Plugins (#1930) 2023-07-04 20:28:43 +02:00
src Docs: make sure shell examples can be copied (#1670) 2023-03-24 18:18:14 +01:00
static Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00
versioned_docs/version-0.15 Add minimum usage for CLI v0.15.x to docs (#1878) 2023-06-25 23:38:25 +02:00
versioned_sidebars Use versioned docs (#1145) 2022-09-01 01:52:52 +02:00
.gitignore [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
.prettierrc.js Improve docs (#450) 2021-10-16 21:27:51 +02:00
babel.config.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
docusaurus.config.js [Docs] use redocusaurus to display swagger file (#1818) 2023-06-04 05:07:39 +02:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json [Docs] use redocusaurus to display swagger file (#1818) 2023-06-04 05:07:39 +02:00
pnpm-lock.yaml [Docs] use redocusaurus to display swagger file (#1818) 2023-06-04 05:07:39 +02:00
pnpm-workspace.yaml Fix docs build (#1690) 2023-04-03 12:30:01 +02:00
README.md Docs: make sure shell examples can be copied (#1670) 2023-03-24 18:18:14 +01:00
sidebars.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
tsconfig.json Improve docs (#450) 2021-10-16 21:27:51 +02:00
versions.json Use versioned docs (#1145) 2022-09-01 01:52:52 +02:00

Website

This website is built using Docusaurus 2, 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 to woodpecker-ci.org.

To manually build the website and push it exec:

GIT_USER=woodpecker-bot USE_SSH=true DEPLOYMENT_BRANCH=master pnpm deploy