tianji/website
2023-12-25 09:55:51 +08:00
..
blog feat: init website 2023-10-29 02:23:19 +08:00
docs feat: init website 2023-10-29 02:23:19 +08:00
src docs: update changelog 2023-12-25 09:55:51 +08:00
static docs: update preview image page 2023-12-25 00:35:11 +08:00
.gitignore feat: init website 2023-10-29 02:23:19 +08:00
babel.config.js feat: init website 2023-10-29 02:23:19 +08:00
docusaurus.config.js docs: add discord invite link 2023-12-24 15:58:45 +08:00
openapi.json docs: update openapi 2023-12-24 15:58:14 +08:00
package.json docs: add changelog page 2023-12-16 15:34:00 +08:00
pnpm-lock.yaml docs: add changelog page 2023-12-16 15:34:00 +08:00
README.md feat: init website 2023-10-29 02:23:19 +08:00
sidebars.js feat: init website 2023-10-29 02:23:19 +08:00
tailwind.config.ts docs: add docker install command 2023-12-24 15:58:30 +08:00
tsconfig.json feat: init website 2023-10-29 02:23:19 +08: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

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.