1
0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-11-30 08:06:52 +02:00
woodpecker/docs
Anbraten 72e42f1612
Optimize license files (#355)
Updated license files to be automatically be parseable by tools like [licensechecker](https://github.com/google/licensecheck) or Github. This is for example needed for godoc.
2021-09-25 15:15:54 +02:00
..
docs Update 80-kubernetes.md (#350) 2021-09-24 15:45:35 +02:00
src [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
static [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
.gitignore [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
babel.config.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
docusaurus.config.js Improve administration docs (#307) 2021-09-16 18:50:53 +02:00
LICENSE Optimize license files (#355) 2021-09-25 15:15:54 +02:00
package.json [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
README.md Improve administration docs (#307) 2021-09-16 18:50:53 +02:00
sidebars.js [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +02:00
yarn.lock [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +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.github.io.

To manually build the website and push it exec:

GIT_USER=woodpecker-bot USE_SSH=true DEPLOYMENT_BRANCH=master yarn deploy