History

moonrailgun 107d8c5e81 docs: add social card and logo and update config		2023-11-04 17:00:21 +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	feat: init website	2023-10-29 02:23:19 +08:00
static	docs: add social card and logo and update config	2023-11-04 17:00:21 +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 social card and logo and update config	2023-11-04 17:00:21 +08:00
openapi.json	feat: add docusaurus-preset-openapi	2023-10-29 03:00:10 +08:00
package.json	docs: add social card and logo and update config	2023-11-04 17:00:21 +08:00
pnpm-lock.yaml	feat: add docusaurus-preset-openapi	2023-10-29 03:00:10 +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
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.

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