woodpecker/docs
Alexis Lefebvre 1c4efe1582
use example.com instead of foo.com (#1188)
http://example.com/ is a reserved domain name, which is perfect for
examples, while foo.com is a random domain name
2022-09-14 15:19:03 +02:00
..
docs use example.com instead of foo.com (#1188) 2022-09-14 15:19:03 +02:00
plugins/woodpecker-plugins Update and cleanup docs (#851) 2022-04-06 17:15:28 +02:00
src Extend FAQ with clone debugging howto (#996) 2022-06-20 19:15:15 +02:00
static Add gitpod setup (#1020) 2022-07-31 17:07:18 +02:00
versioned_docs/version-0.15 use example.com instead of foo.com (#1188) 2022-09-14 15:19:03 +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 Add Translation Platform to Docs (#1168) 2022-09-04 09:37:27 +02:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Use local search and update docusaurus (#1093) 2022-08-14 09:19:24 +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 Use local search and update docusaurus (#1093) 2022-08-14 09:19:24 +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