woodpecker/docs
Anbraten 2bfeb9e1fa
Improve administration docs (#307)
* Improve administration docs

* Correct docker image names

* Update docs README

Co-authored-by: 6543 <6543@obermui.de>
2021-09-16 18:50:53 +02:00
..
docs Improve administration docs (#307) 2021-09-16 18:50:53 +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 Moved all, will break pipelines up a bit more 2019-11-15 11:36:41 +01: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