tianji/website
2024-10-07 20:18:01 +08:00
..
docs docs: resolve build problem with update source document content 2024-10-05 18:18:02 +08:00
i18n docs: resolve build problem with update source document content 2024-10-05 18:18:02 +08:00
src docs: add private-policy page 2024-08-26 01:23:33 +08:00
static docs: add website more language: de, fr, ja, zh-Hans 2024-10-05 17:52:02 +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.ts docs: add sitemap to improve SEO 2024-10-07 17:16:11 +08:00
openapi.json docs: update openapi files 2024-08-25 03:18:36 +08:00
package.json docs: update depenpendency to resolve issue of docusaurus build 2024-10-07 20:18:01 +08:00
postcss.config.js docs: fix README/website style problem 2024-01-28 16:01:15 +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 docs: uprade docs website to v3.3.2 2024-05-16 21:25:38 +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.