woodpecker/docs
6543 1d2f594fc6
update docs about versioning (#2043)
#2040 did point out, it needs to be better clarified
2023-07-27 15:46:20 +02:00
..
blog/2023-06-11-hello-blog Add a blog (#1978) 2023-07-11 23:31:45 +02:00
docs update docs about versioning (#2043) 2023-07-27 15:46:20 +02:00
plugins/woodpecker-plugins Add Kubernetes and Dockle Plugins (#1930) 2023-07-04 20:28:43 +02:00
src update docs about versioning (#2043) 2023-07-27 15:46:20 +02:00
static Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00
versioned_docs Create docs for v1.0.x (#1855) 2023-07-25 12:41:58 +02:00
versioned_sidebars Create docs for v1.0.x (#1855) 2023-07-25 12:41:58 +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 Set v1.0 documents as default and mark v0.15 as unmaintained (#2034) 2023-07-26 20:06:43 +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 Create docs for v1.0.x (#1855) 2023-07-25 12:41:58 +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