woodpecker/docs
lonix1 36bfc92fc8
docs: yaml cheatsheet for advanced syntax (#2329)
official spec linked at top of page is inaccessible for most readers
(it's too dry and academic)
so added famous cheatsheet (heavily promoted on StackOverflow)
2023-08-28 16:24:56 +02:00
..
blog Blog post for v1.0.0 release (#2055) 2023-07-29 16:05:44 +02:00
docs docs: yaml cheatsheet for advanced syntax (#2329) 2023-08-28 16:24:56 +02:00
plugins/woodpecker-plugins Update docs deps to address cves (#2080) 2023-08-01 13:30:44 +02:00
src Fix version in FAQ (#2101) 2023-08-03 10:48:39 +02:00
static Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00
versioned_docs Add "plugin" support to local backend (#2239) 2023-08-22 22:00:32 +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 Better blog title/desc (#2182) 2023-08-09 15:23:13 +02:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Update docs deps to address cves (#2080) 2023-08-01 13:30:44 +02:00
pnpm-lock.yaml Update docs deps to address cves (#2080) 2023-08-01 13:30:44 +02:00
pnpm-workspace.yaml Fix docs build (#1690) 2023-04-03 12:30:01 +02:00
README.md Change master to main (#2044) 2023-07-31 05:47:23 +02: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=main pnpm deploy