ByConity/website
pswai 6d49fba99e Add i18n 2023-02-27 12:54:03 +08:00
..
blog Add 'website/' from commit '4eb7e10bbe5faec5a2c5b71c143d683a310ebcb7' 2023-02-15 11:01:30 +08:00
i18n Add i18n 2023-02-27 12:54:03 +08:00
src Add i18n 2023-02-27 12:54:03 +08:00
static Move documentation files to the /docs folder 2023-02-23 11:54:18 +08:00
README.md Add 'website/' from commit '4eb7e10bbe5faec5a2c5b71c143d683a310ebcb7' 2023-02-15 11:01:30 +08:00
babel.config.js Add 'website/' from commit '4eb7e10bbe5faec5a2c5b71c143d683a310ebcb7' 2023-02-15 11:01:30 +08:00
docusaurus.config.js Complete simple homepage 2023-02-27 12:54:03 +08:00
package.json Complete simple homepage 2023-02-27 12:54:03 +08:00
pnpm-lock.yaml Complete simple homepage 2023-02-27 12:54:03 +08:00
sidebars.js Add 'website/' from commit '4eb7e10bbe5faec5a2c5b71c143d683a310ebcb7' 2023-02-15 11:01:30 +08:00
tsconfig.json Add 'website/' from commit '4eb7e10bbe5faec5a2c5b71c143d683a310ebcb7' 2023-02-15 11:01:30 +08: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

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.