wehub-resource-sync
167 lines
6.4 KiB
Markdown
167 lines
6.4 KiB
Markdown
<!-- WEHUB_ZH_README -->
|
||
> [!NOTE]
|
||
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
|
||
> [English](./README.en.md) · [原始项目](https://github.com/cloudflare/workers-sdk) · [上游 README](https://github.com/cloudflare/workers-sdk/blob/HEAD/README.md)
|
||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||
|
||
<h1 align="center">Cloudflare Workers SDK</h1>
|
||
|
||
<p align="center">
|
||
<img src="cloudflare-workers-outline.png" alt="workers-logo" width="120px" height="120px"/>
|
||
<br>
|
||
Cloudflare Workers 让你能够在全球范围内即时部署无服务器（serverless）代码，以获得出色的性能、可靠性和可扩展性。
|
||
<br>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="CONTRIBUTING.md">参与贡献</a>
|
||
·
|
||
<a href="https://github.com/cloudflare/workers-sdk/issues">提交 Issue</a>
|
||
·
|
||
<a href="https://discord.cloudflare.com/">加入 Discord</a>
|
||
<br>
|
||
<br>
|
||
</p>
|
||
|
||
<p align="center">
|
||
<a href="https://www.npmjs.com/wrangler/">
|
||
<img src="https://img.shields.io/npm/v/wrangler.svg?logo=npm&logoColor=fff&label=NPM+package&color=orange" alt="Wrangler on npm" />
|
||
</a>
|
||
<a href="https://discord.cloudflare.com/">
|
||
<img src="https://img.shields.io/discord/595317990191398933.svg?logo=discord&logoColor=fff&label=Discord&color=7389d8" alt="Discord conversation" />
|
||
</a>
|
||
<a href="https://twitter.com/CloudflareDev">
|
||
<img src="https://img.shields.io/twitter/follow/cloudflaredev" alt="X conversation" />
|
||
</a>
|
||
</p>
|
||
|
||
<hr>
|
||
|
||
## 快速入门
|
||
|
||
若要快速开始一个新项目，请运行以下命令：
|
||
|
||
```bash
|
||
npm create cloudflare@latest
|
||
# or
|
||
pnpm create cloudflare@latest
|
||
# or
|
||
yarn create cloudflare@latest
|
||
```
|
||
|
||
更多信息，请访问我们的[入门指南](https://developers.cloudflare.com/workers/get-started/guide/) guide。
|
||
|
||
## 文档
|
||
|
||
请访问官方 Workers 文档[此处](https://developers.cloudflare.com/workers/).
|
||
|
||
- [入门指南](https://developers.cloudflare.com/workers/get-started/guide/)
|
||
- [Workers 工作原理](https://developers.cloudflare.com/workers/reference/how-workers-works/)
|
||
- [Wrangler CLI](https://developers.cloudflare.com/workers/wrangler/)
|
||
- [可观测性（Observability）](https://developers.cloudflare.com/workers/observability/)
|
||
- [平台](https://developers.cloudflare.com/workers/platform/)
|
||
|
||
## 目录
|
||
|
||
| 包 | 说明 | 链接 |
|
||
| ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
|
||
| [`wrangler`](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler) | 用于构建 [Cloudflare Workers](https://workers.cloudflare.com/). 的命令行工具 | [文档](https://developers.cloudflare.com/workers/wrangler/) |
|
||
| [`create-cloudflare` (C3)](https://github.com/cloudflare/workers-sdk/tree/main/packages/create-cloudflare) | 用于在 Cloudflare 上创建和部署新应用的 CLI。 | [文档](https://developers.cloudflare.com/pages/get-started/c3/) |
|
||
| [`miniflare`](https://github.com/cloudflare/workers-sdk/tree/main/packages/miniflare) | 用于开发和测试 Cloudflare Workers 的模拟器，由 [workerd](https://github.com/cloudflare/workerd) 驱动 | [文档](https://miniflare.dev) |
|
||
| [`chrome-devtools-patches`](https://github.com/cloudflare/workers-sdk/tree/main/packages/chrome-devtools-patches) | Cloudflare 对 Chrome DevTools 的分支，用于检查本地或远程 Workers | |
|
||
| [`pages-shared`](https://github.com/cloudflare/workers-sdk/tree/main/packages/pages-shared) | 在内部用于驱动 Wrangler 和 Cloudflare Pages，包含这些客户端之间共享的全部代码。 | |
|
||
|
||
## Beta 版本
|
||
|
||
Beta 版本由 [pkg.pr.new](https://github.com/stackblitz-labs/pkg.pr.new) 工具生成，并在每次推送到 `main` 分支的提交时更新。
|
||
|
||
> [!Warning]
|
||
> 这些 Beta 版本会随时间不断更新，因此不适合作为项目的稳定版本（应改用正式发布的 npm 版本）。它们仅应用于快速测试尚未发布的功能/修复。
|
||
|
||
可用的 Beta 版本如下所列。
|
||
|
||
<details><summary><b>create-cloudflare</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/create-cloudflare@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
<details><summary><b>@cloudflare/kv-asset-handler</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/@cloudflare/kv-asset-handler@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
<details><summary><b>miniflare</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/miniflare@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
<details><summary><b>@cloudflare/pages-shared</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/@cloudflare/pages-shared@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
<details><summary><b>@cloudflare/unenv-preset</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/@cloudflare/unenv-preset@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
<details><summary><b>@cloudflare/vite-plugin</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/@cloudflare/vite-plugin@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
<details><summary><b>@cloudflare/vitest-pool-workers</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/@cloudflare/vitest-pool-workers@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
<details><summary><b>@cloudflare/workers-editor-shared</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/@cloudflare/workers-editor-shared@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
<details><summary><b>wrangler</b></summary><p>
|
||
|
||
```
|
||
npm i https://pkg.pr.new/wrangler@main
|
||
```
|
||
|
||
</p></details>
|
||
|
||
## 参与贡献
|
||
|
||
我们欢迎新的贡献者！详情请参阅 [`CONTRIBUTING.md`](/CONTRIBUTING.md) 指南。
|
||
|
||
## 社区
|
||
|
||
欢迎加入官方 [Cloudflare Discord](https://discord.cloudflare.com/)，与其他开发者交流、提问或了解更多信息。
|
||
|
||
## 链接
|
||
|
||
- [项目看板](https://github.com/orgs/cloudflare/projects/1)
|
||
- [讨论](https://github.com/cloudflare/workers-sdk/discussions)
|