# Fast.Docs

**Repository Path**: FastDotnet/Fast.Docs

## Basic Information

- **Project Name**: Fast.Docs
- **Description**: 1111111111111111111111
- **Primary Language**: TypeScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-20
- **Last Updated**: 2026-09-20

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[English](./README.md) | **简体中文**

# Fast.Docs

**[使用文档](http://docs.fastdotnet.cn/) · [官方网站](http://fastdotnet.com)**

FastDotNet 的统一 VitePress 文档站，维护七个前端包与 Fast.NET 的用户指南、API 说明和示例。站点首页提供项目入口，各产品拥有独立首页、导航与仓库链接。

简体中文内容位于 `docs/zh-CN`，美式英文内容位于 `docs/en-US`。根地址默认进入 `/zh-CN/`，语言切换进入对应页面。

站点配置与展示组件位于 `docs/.vitepress`；七个前端产品位于 `docs/zh-CN/frontend/<产品>`，Fast.NET 位于 `docs/zh-CN/backend/fast-net`。组件交互示例归入 `docs/zh-CN/frontend/element-plus/examples`。URL 与目录一致。`applications/fast-admin` 暂不纳入本轮内容范围。

Fast.NET 公开声明参考由 `pwsh -NoProfile -File scripts/export-dotnet-api.ps1` 从只读源码生成，可用 `-Source` 指定已授权的源仓库。该命令只使用 Roslyn 解析声明和 XML 注释，不编译或执行 SDK；普通站点构建不依赖源仓库。

## 本地运行

```bash
pnpm install --frozen-lockfile
pnpm run dev
```

## 验证

```bash
pnpm run typecheck
pnpm run test:docs
pnpm run build
pnpm run check:links
pnpm run check
```

普通安装、构建和文档测试只使用锁定的公开 npm 包及已保存的 API 基线，不需要同级源码仓库。

ESLint 规则生成器留在 Fast.ESLint.Config。先在源库运行生成及检查，再按需执行本站的 `pnpm run docs:rules` 和 `pnpm run docs:rules:check`；非同级来源使用 `--source=<repository-path>`。同步仅转换文档链接，不改变规则语义或正反示例。

维护者可按需运行 `pnpm run check:sources` 对照同级源码；非同级路径使用 `pnpm run check:sources -- <parent-directory>`。此命令只读核对，不会更新基线或接受 API 删除。完整语义审阅与兼容性审阅不能由名称清单代替。

```bash
dotnet restore examples/dotnet/GettingStarted/GettingStarted.csproj --locked-mode
pnpm run check:dotnet
```

C# 示例只编译，不启动宿主或数据库。每个 NuGet 包的有效版本和目标单独记录。

## 产品入口

- [Fast.Element.Plus](./docs/zh-CN/index.md)
- [Fast.ESLint.Config](./docs/zh-CN/frontend/eslint-config/index.md)
- [Fast.ESLint.Config.Legacy](./docs/zh-CN/frontend/eslint-config-legacy/index.md)
- [Fast.Vite.Plugins](./docs/zh-CN/frontend/vite-plugins/index.md)
- [Fast.Utils](./docs/zh-CN/frontend/utils/index.md)
- [Fast.Axios](./docs/zh-CN/frontend/axios/index.md)
- [Fast.Element.Plus.Icons](./docs/zh-CN/frontend/element-plus-icons/index.md)
- [Fast.NET](./docs/zh-CN/backend/fast-net/index.md)

- [API coverage and known gaps](./docs/zh-CN/api-coverage.md)
- [Static hosting instructions](./docs/zh-CN/frontend/element-plus/guide/deployment.md)

源码、生成器、源码注释、测试 fixture、许可和维护者资料保留在对应 SDK。文档审阅版本只有在完成差异核对与验证后才更新；迁入文档不等于重新核对全部 API。