mirrors/woodpecker
1
0
Fork 0
mirror of https://github.com/woodpecker-ci/woodpecker.git synced 2024-12-30 12:20:33 +00:00
Code Issues Projects Releases Wiki Activity
woodpecker/docs
History
Anbraten 9267a46d5c
[Docs] Migrate docs framework to Docusaurus (#282) 
- Replace mkdocs with docosaurus (improved menu structure, ...)
- Structure docs into `Usage` and `Server Setup / Administration`
- Update favicon
- Create new pipeline-syntax page with all options and links to more detailed docs if available
- Add ci to publish to `woodpecker-ci.github.io`
- Deploy docs preview to surge for review
- Update start-page

Co-authored-by: 6543 <6543@obermui.de>
2021-09-11 17:10:32 +02:00
..
docs [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +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 [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +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 [Docs] Migrate docs framework to Docusaurus (#282) 2021-09-11 17:10:32 +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

README.md

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

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.