woodpecker/docs
smainz 73067c5868
Add a sentence regarding translations to the development docs (UI page) (#1459)
Make obvious, that at least an English message key has to be added to the message files
2022-12-21 14:45:41 +01:00
..
docs Add a sentence regarding translations to the development docs (UI page) (#1459) 2022-12-21 14:45:41 +01:00
plugins/woodpecker-plugins Point docs navbar items to selected version (#1434) 2022-11-19 15:21:03 +01:00
src Fix broken link in FAQ (#1413) 2022-11-10 18:36:41 +01:00
static Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00
versioned_docs/version-0.15 Spelling (#1405) 2022-11-09 08:12:17 +01: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 Point docs navbar items to selected version (#1434) 2022-11-19 15:21:03 +01:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Point docs navbar items to selected version (#1434) 2022-11-19 15:21:03 +01:00
pnpm-lock.yaml Point docs navbar items to selected version (#1434) 2022-11-19 15:21:03 +01:00
README.md Replace yarn with pnpm (#1240) 2022-10-08 16:15:07 +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 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