History

moonrailgun e402ee1688 chore: update openapi document		2024-10-23 23:53:32 +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: change code command line style	2024-10-12 20:07:37 +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
components.json	docs: change code command line style	2024-10-12 20:07:37 +08:00
docusaurus.config.ts	chore: rename old tsconfig paths	2024-10-16 01:16:21 +08:00
openapi.json	chore: update openapi document	2024-10-23 23:53:32 +08:00
package.json	docs: change code command line style	2024-10-12 20:07:37 +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: change code command line style	2024-10-12 20:07:37 +08:00
tsconfig.json	docs: change code command line style	2024-10-12 20:07:37 +08:00

Website

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

$ yarn

$ 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.

$ yarn build

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

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.