cocos-enhance-kit/docs-src
2022-05-20 11:29:08 +08:00
..
blog Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
docs Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
src Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
static Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
.gitignore Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
babel.config.js Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
docusaurus.config.js Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
package-lock.json Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
package.json Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
README.md Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
sidebars.js Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +08:00
tsconfig.json Revert "Deploy website - based on e4dceb38ef43734f267725d69df0492506ff7011" 2022-05-20 11:29:08 +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.