excalidraw--excalidraw
wehub-resource-sync
133 行
8.0 KiB
Markdown
133 行
8.0 KiB
Markdown
<!-- WEHUB_ZH_README -->
|
||
> [!NOTE]
|
||
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
|
||
> [English](./README.en.md) · [原始项目](https://github.com/excalidraw/excalidraw) · [上游 README](https://github.com/excalidraw/excalidraw/blob/HEAD/README.md)
|
||
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
|
||
|
||
<a href="https://excalidraw.com/" target="_blank" rel="noopener">
|
||
<picture>
|
||
<source media="(prefers-color-scheme: dark)" alt="Excalidraw" srcset="https://excalidraw.nyc3.cdn.digitaloceanspaces.com/github/excalidraw_github_cover_2_dark.png" />
|
||
<img alt="Excalidraw" src="https://excalidraw.nyc3.cdn.digitaloceanspaces.com/github/excalidraw_github_cover_2.png" />
|
||
</picture>
|
||
</a>
|
||
|
||
<h4 align="center">
|
||
<a href="https://excalidraw.com">Excalidraw 编辑器</a> |
|
||
<a href="https://plus.excalidraw.com/blog">博客</a> |
|
||
<a href="https://docs.excalidraw.com">文档</a> |
|
||
<a href="https://plus.excalidraw.com">Excalidraw+</a>
|
||
</h4>
|
||
|
||
<div align="center">
|
||
<h2>
|
||
一款开源的虚拟手绘风格白板。 </br>
|
||
支持协作与端到端加密。 </br>
|
||
<br />
|
||
</h2>
|
||
</div>
|
||
|
||
<br />
|
||
<p align="center">
|
||
<a href="https://github.com/excalidraw/excalidraw/blob/master/LICENSE">
|
||
<img alt="Excalidraw 采用 MIT 许可证发布。" src="https://img.shields.io/badge/license-MIT-blue.svg" /></a>
|
||
<a href="https://www.npmjs.com/package/@excalidraw/excalidraw">
|
||
<img alt="npm 月下载量" src="https://img.shields.io/npm/dm/@excalidraw/excalidraw" /></a>
|
||
<a href="https://docs.excalidraw.com/docs/introduction/contributing">
|
||
<img alt="欢迎提交 PR！" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat" /></a>
|
||
<a href="https://discord.gg/UexuTaE">
|
||
<img alt="在 Discord 上聊天" src="https://img.shields.io/discord/723672430744174682?color=738ad6&label=Chat%20on%20Discord&logo=discord&logoColor=ffffff&widget=false"/></a>
|
||
<a href="https://deepwiki.com/excalidraw/excalidraw">
|
||
<img alt="向 DeepWiki 提问" src="https://deepwiki.com/badge.svg" /></a>
|
||
<a href="https://twitter.com/excalidraw">
|
||
<img alt="在 Twitter 上关注 Excalidraw" src="https://img.shields.io/twitter/follow/excalidraw.svg?label=follow+@excalidraw&style=social&logo=twitter"/></a>
|
||
</p>
|
||
|
||
<div align="center">
|
||
<figure>
|
||
<a href="https://excalidraw.com" target="_blank" rel="noopener">
|
||
<img src="https://excalidraw.nyc3.cdn.digitaloceanspaces.com/github%2Fproduct_showcase.png" alt="产品展示" />
|
||
</a>
|
||
<figcaption>
|
||
<p align="center">
|
||
创建精美的手绘风格图表、线框图或任何你想要的内容。
|
||
</p>
|
||
</figcaption>
|
||
</figure>
|
||
</div>
|
||
|
||
## 功能特性
|
||
|
||
Excalidraw 编辑器（npm 包）支持：
|
||
|
||
- 💯 免费且开源。
|
||
- 🎨 无限画布白板。
|
||
- ✍️ 手绘风格。
|
||
- 🌓 深色模式。
|
||
- 🏗️ 可定制。
|
||
- 📷 图片支持。
|
||
- 😀 形状库支持。
|
||
- 🌐 国际化（i18n）支持。
|
||
- 🖼️ 导出为 PNG、SVG 及剪贴板。
|
||
- 💾 开放格式 — 将绘图导出为 `.excalidraw` json 文件。
|
||
- ⚒️ 丰富的工具集 — 矩形、圆形、菱形、箭头、线条、自由绘制、橡皮擦……
|
||
- ➡️ 箭头绑定与带标签箭头。
|
||
- 🔙 撤销 / 重做。
|
||
- 🔍 缩放与平移支持。
|
||
|
||
## Excalidraw.com
|
||
|
||
托管于 [excalidraw.com](https://excalidraw.com) 的应用是 Excalidraw 所构建能力的最小化展示。其[源代码](https://github.com/excalidraw/excalidraw/tree/master/excalidraw-app) 也属于本仓库的一部分，该应用还具备：
|
||
|
||
- 📡 PWA 支持（离线可用）。
|
||
- 🤼 实时协作。
|
||
- 🔒 端到端加密。
|
||
- 💾 本地优先支持（自动保存至浏览器）。
|
||
- 🔗 可分享链接（导出为只读链接供他人查看）。
|
||
|
||
未来我们会将这些功能以即插即用插件的形式提供给 npm 包。
|
||
|
||
## 快速开始
|
||
|
||
**注意：** 以下说明适用于将 Excalidraw [npm 包](https://www.npmjs.com/package/@excalidraw/excalidraw) 集成到您自己的应用中。如需在本地运行本仓库进行开发，请参考我们的[开发指南](https://docs.excalidraw.com/docs/introduction/development).。
|
||
|
||
使用 `npm` 或 `yarn` 安装该包。
|
||
|
||
```bash
|
||
npm install react react-dom @excalidraw/excalidraw
|
||
# or
|
||
yarn add react react-dom @excalidraw/excalidraw
|
||
```
|
||
|
||
更多详情请查阅我们的[文档](https://docs.excalidraw.com/docs/@excalidraw/excalidraw/installation))！
|
||
|
||
## 贡献
|
||
|
||
- 缺少某项功能或发现了 Bug？[在此报告](https://github.com/excalidraw/excalidraw/issues).)。
|
||
- 想要贡献代码？请查阅我们的[贡献指南](https://docs.excalidraw.com/docs/introduction/contributing))，或在 [Discord](https://discord.gg/UexuTaE).) 上告诉我们。
|
||
- 想要帮助翻译？请参阅[翻译指南](https://docs.excalidraw.com/docs/introduction/contributing#translating).)。
|
||
|
||
## 集成
|
||
|
||
- [VScode 扩展](https://marketplace.visualstudio.com/items?itemName=pomdtr.excalidraw-editor))
|
||
- [npm 包](https://www.npmjs.com/package/@excalidraw/excalidraw))
|
||
|
||
## 谁在使用 Excalidraw
|
||
|
||
[Google Cloud](https://googlecloudcheatsheet.withgoogle.com/architecture)) • [Meta](https://meta.com/)) • [CodeSandbox](https://codesandbox.io/)) • [Obsidian Excalidraw](https://github.com/zsviczian/obsidian-excalidraw-plugin)) • [Replit](https://replit.com/)) • [Slite](https://slite.com/)) • [Notion](https://notion.so/)) • [HackerRank](https://www.hackerrank.com/)) • 以及更多其他团队
|
||
|
||
## 赞助与支持
|
||
|
||
如果您喜欢这个项目，可以在 [Open Collective](https://opencollective.com/excalidraw)) 上成为赞助者，或使用 [Excalidraw+](https://plus.excalidraw.com/).)。
|
||
|
||
## 感谢您对 Excalidraw 的支持
|
||
|
||
[<img src="https://opencollective.com/excalidraw/tiers/sponsors/0/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/0/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/1/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/1/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/2/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/2/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/3/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/3/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/4/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/4/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/5/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/5/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/6/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/6/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/7/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/7/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/8/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/8/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/9/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/9/website)) [<img src="https://opencollective.com/excalidraw/tiers/sponsors/10/avatar.svg?avatarHeight=120"/>](https://opencollective.com/excalidraw/tiers/sponsors/10/website))
|
||
|
||
<a href="https://opencollective.com/excalidraw#category-CONTRIBUTE" target="_blank"><img src="https://opencollective.com/excalidraw/tiers/backers.svg?avatarHeight=32"/></a>
|
||
|
||
最后但同样重要的是，我们感谢以下公司免费提供的服务：
|
||
|
||
[](https://vercel.com)) [](https://sentry.io)) [](https://crowdin.com))
|
||
|
||
USD 预算：$0/$3；剩余 $3，暂不接受新翻译。需要使用替代方案：否。请使用相同格式。
|