woodpecker/docs
6543 a39e8a0f9a
Make exec run be detected as WoodpeckerCI (#1218)
and exclude docs/docs/40-cli.md from git as it will be generated by CI
2022-09-27 22:19:39 +02:00
..
docs Make exec run be detected as WoodpeckerCI (#1218) 2022-09-27 22:19:39 +02:00
plugins/woodpecker-plugins Add my plugins (#1204) 2022-09-27 09:30:04 +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 use example.com instead of foo.com (#1188) 2022-09-14 15:20:27 +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 Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00
README.md Update links to woodpecker-ci.org (#445) 2021-10-14 18:13:57 +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
yarn.lock Improve plugins index (#1200) 2022-09-25 19:04:47 +02:00

Website

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

Installation

$ yarn

Local Development

$ yarn 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

$ yarn 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 yarn deploy