diff --git a/README.md b/README.md index d9706bb8dd442f594304c098bea5e6ee3f131e68..d3b9fe96765908d870f10538ffd10cc8b0786d4f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# Gitee AI 文档 +# 模力方舟文档 + +该仓库是模力方舟平台的文档项目,包含了使用手册以及 API 文档。其中 API 文档使用了 [Scalar](https://scalar.com/) 进行展示。对应网址是 https://ai.gitee.com/docs 。 ### 安装依赖 @@ -12,34 +14,22 @@ $ yarn $ cp .env.example .env ``` -### 开发 +修改 .evn 文件,注释掉生产环境的配置项,取消开发环境的配置项注释。 -``` -$ 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 +$ yarn start ``` -This command generates static content into the `build` directory and can be served using any static contents hosting service. - -### 部署到 Gitee Pages - -Using SSH: +这个命令会启动本地开发服务器,并自动打开浏览器窗口。大多数更改都会实时生效,无需重启服务器。 -``` -$ USE_SSH=true yarn deploy -``` +### 生产环境构建 -Not using SSH: +构建之前请将 .env 文件中的开发环境配置项注释掉,取消生产环境的配置项注释。 ``` -$ GIT_USER= yarn deploy +$ yarn build ``` -If you are using Gitee pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. +这个命令会将静态内容生成到 build 目录中,可以通过任何静态资源托管服务进行部署。