1
0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-12 08:23:48 +02:00
woodpecker/docs
Anbraten ee97977b93
Update and cleanup docs (#851)
- migrate step conditions back into pipeline syntax, but show 2-4 level in toc to be able to see `when` keywords
- create new backend section in admin docs
- update docusaurus
- remove prefix docker of container / container-image where possible
- replace terms SCM, VCS, Github with [forge](https://en.wikipedia.org/wiki/Forge_(software))
- add darkmode favicon variant
2022-04-06 17:15:28 +02:00
..
docs Update and cleanup docs (#851) 2022-04-06 17:15:28 +02:00
plugins/woodpecker-plugins Update and cleanup docs (#851) 2022-04-06 17:15:28 +02:00
src Update and cleanup docs (#851) 2022-04-06 17:15:28 +02:00
static Update and cleanup docs (#851) 2022-04-06 17:15:28 +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 Update and cleanup docs (#851) 2022-04-06 17:15:28 +02:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json Update and cleanup docs (#851) 2022-04-06 17:15:28 +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
yarn.lock Update and cleanup docs (#851) 2022-04-06 17:15:28 +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