Skip to content

yunionio/website

Repository files navigation

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

$ yarn

# or install packages by using container
$ make docker-yarn

Local Development

$ yarn start

# or run inside container
$ make docker-start

# english i18n
$ make start-en

# or
$ make docker-start-en

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

# or build by using container
$ make docker-build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> 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.