woodpecker/docs
Paul Tötterman efd2cf8a6f
Spelling consistently (#1267)
Since you gladly accepted my typo fix commit, I started doing some spell
and consistency checking for the docs.

Co-authored-by: 6543 <6543@obermui.de>
2022-10-14 16:57:45 +02:00
..
docs Spelling consistently (#1267) 2022-10-14 16:57:45 +02:00
plugins/woodpecker-plugins Use fallback icon on plugin page (#1268) 2022-10-14 16:20:54 +02:00
src Extend FAQ with clone debugging howto (#996) 2022-06-20 19:15:15 +02:00
static Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00
versioned_docs/version-0.15 Fix typo (#1265) 2022-10-14 13:43:29 +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 Respect preferred color scheme in docs (#1241) 2022-10-08 10:53:42 +02:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Replace yarn with pnpm (#1240) 2022-10-08 16:15:07 +02:00
pnpm-lock.yaml Replace yarn with pnpm (#1240) 2022-10-08 16:15:07 +02: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