mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2025-02-24 15:16:19 +00:00
Code Issues Projects Releases Wiki Activity
woodpecker/docs
History
Szymon Nowicki 6ef0e5d799 Docs: inform about plugins build needed for the first docs build
2025-02-16 12:49:51 +01:00
..
blog Drop versioned docs for v1 (#4844) 2025-02-16 08:14:57 +02:00
docs docs: remove latest from docker compose example (#4849) 2025-02-15 20:33:52 +01:00
plugins/woodpecker-plugins Add a Home Assistant notification plugin (#4841) 2025-02-14 09:04:57 +02:00
src Revert "Tag pipeline with source information (#4771)" (#4794) 2025-01-31 14:53:41 +02:00
static/img Use icon sizes relative to font size (#4575) 2024-12-21 20:37:08 +01:00
versioned_docs Drop versioned docs for v1 (#4844) 2025-02-16 08:14:57 +02:00
versioned_sidebars Drop versioned docs for v1 (#4844) 2025-02-16 08:14:57 +02:00
.gitignore [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
.prettierignore Add prettier to docs/ (#4628) 2024-12-28 15:36:23 +01:00
.prettierrc.js Fix syntax for dynamic docs versioning (#4708) 2025-01-12 12:37:47 +02:00
docusaurus.config.ts Various docs improvements (#4772) 2025-01-27 09:15:44 +01:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json fix(deps): update docs npm deps non-major (#4733) 2025-01-18 11:13:46 +01:00
pnpm-lock.yaml chore(deps): lock file maintenance (#4845) 2025-02-14 12:44:41 +01:00
pnpm-workspace.yaml Fix docs build (#1690) 2023-04-03 12:30:01 +02:00
README.md Docs: inform about plugins build needed for the first docs build 2025-02-16 12:49:51 +01:00
sidebars.js Add prettier (#2600) 2023-10-24 14:42:05 +02:00
tsconfig.json Update prettier version (#3471) 2024-03-08 14:57:34 +01:00
versions.json Drop versioned docs for v1 (#4844) 2025-02-16 08:14:57 +02:00
woodpecker.png Update some readme wording (#4023) 2024-08-11 10:26:26 +02:00

README.md

Website

This website is built using Docusaurus 3, a modern static website generator.

Installation

pnpm install

Before your first build

Before running build or start commands for the first time, you need to build plugins in docs/plugins/woodpecker-plugins:

cd docs/plugins/woodpecker-plugins
pnpm build

Build

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.

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=main pnpm deploy