# docs

**Repository Path**: moark/docs

## Basic Information

- **Project Name**: docs
- **Description**: 模力方舟官方文档仓库
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: https://moark.com/docs
- **GVP Project**: No

## Statistics

- **Stars**: 14
- **Forks**: 8
- **Created**: 2024-04-01
- **Last Updated**: 2026-09-07

## Categories & Tags

**Categories**: ebooks-manual

**Tags**: None

## README

# 模力方舟文档

该仓库是模力方舟平台的文档项目，包含了使用手册以及 API 文档。其中 API 文档使用了 [Scalar](https://scalar.com/)
进行展示。对应网址是 https://ai.gitee.com/docs 。

### 安装依赖

```
yarn
```

### 添加 env 文件

```
cp .env.example .env
```

修改 .evn 文件，注释掉生产环境的配置项，取消开发环境的配置项注释。

### 启动开发环境

```
yarn start
```

这个命令会启动本地开发服务器，并自动打开浏览器窗口。大多数更改都会实时生效，无需重启服务器。

### 生产环境构建

构建之前请将 .env 文件中的开发环境配置项注释掉，取消生产环境的配置项注释。

```
yarn build
```

这个命令会将静态内容生成到 build 目录中，可以通过任何静态资源托管服务进行部署。

### 代码检查

项目使用 [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) 和 [AutoCorrect](https://github.com/nicedoc/autocorrect) 进行文档格式检查。markdownlint-cli2 随 `yarn` 自动安装，AutoCorrect 需要单独安装：

```
# macOS
brew install autocorrect

# 或使用 Cargo
cargo install autocorrect
```

常用命令：

```
yarn lint          # 检查所有文档
yarn lint:fix      # 自动修复所有文档
yarn lint:md       # 仅检查 Markdown 格式
yarn lint:md:fix   # 仅自动修复 Markdown 格式
yarn lint:autocorrect       # 仅检查中英文排版
yarn lint:autocorrect:fix   # 仅自动修复中英文排版
```


# 海外版

### 添加 env 文件

```
cp .env.overseas.example .env.overseas
```

### 启动服务

```
yarn start:overseas
```