cocos-enhance-kit/docs
2022-07-13 00:18:48 +08:00
..
docs 更新至 1.1.0 版本文档 2022-07-13 00:18:48 +08:00
src 名称修改为 enhance-kit 2022-07-11 12:10:40 +08:00
static 更新 Logo 2022-07-11 20:21:56 +08:00
versioned_docs 更新至 1.1.0 版本文档 2022-07-13 00:18:48 +08:00
versioned_sidebars 更新至 1.1.0 版本文档 2022-07-13 00:18:48 +08:00
.gitignore docs 2022-05-20 11:31:56 +08:00
babel.config.js docs 2022-05-20 11:31:56 +08:00
docusaurus.config.js 更新至 1.1.0 版本文档 2022-07-13 00:18:48 +08:00
package-lock.json 完善 docs 2022-05-20 16:41:38 +08:00
package.json 完善 docs 2022-05-20 16:41:38 +08:00
README.md docs 2022-05-20 11:31:56 +08:00
sidebars.js docs 2022-05-20 11:31:56 +08:00
tsconfig.json docs 2022-05-20 11:31:56 +08:00
versions.json 更新至 1.1.0 版本文档 2022-07-13 00:18:48 +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.