woodpecker/docs
2023-05-31 18:30:41 +02:00
..
docs Add Forge Metadata (#1789) 2023-05-31 18:30:41 +02:00
plugins/woodpecker-plugins Add MkDocs Plugin (#1770) 2023-05-21 07:54:23 +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 Remove unnecessary parenthesis (#1710) 2023-04-20 15:56:40 +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 Add version notes to docs (#1592) 2023-02-28 17:30:25 +01:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Fix docs build (#1690) 2023-04-03 12:30:01 +02:00
pnpm-lock.yaml Fix docs build (#1690) 2023-04-03 12:30:01 +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