面向开发者的本地技术文档已尽量中文化,入口如下:
| 文档 | 说明 |
|---|---|
| 构建与开发指南 | 网页端构建与开发环境 |
| 服务端开发指南 | 本地服务端开发与 Docker 部署 |
| 桌面客户端构建指南 | 桌面客户端构建 |
| Trellis 编码规范 | AI 辅助开发与功能开发规范 |
| Trellis 开发工作流 | 项目开发流程 |
| 安全策略 | 安全问题报告与处理说明 |
| AI 助手说明 | AI 助手在本项目中的工作约定 |
在线产品文档请以 官方文档站点 为准。
欢迎在 GitHub 上为项目点亮星标,也可以关注仓库的版本发布,及时获取更新通知!
AFFiNE 是一个开源的一体化工作空间。它将构建知识库所需的各种内容块整合在一起,支持维基、知识管理、演示文稿、数字资产管理等多种场景,为 Notion 和 Miro 提供另一种选择。
容纳各种内容块的真正画布,让文档与白板融为一体。
- 许多编辑器都希望成为提升效率的创作画布,而 AFFiNE 支持将各种内容块放到无边界画布上:富文本、便签、嵌入网页、多视图数据库、关联页面、图形,甚至幻灯片,都可以自由组合。
随时参与工作的多模态 AI 伙伴。
- 撰写专业工作报告、将大纲转为生动的演示文稿、把文章整理成结构清晰的思维导图、梳理工作计划与待办任务,或用一句提示词绘图、编写应用和网页原型:AFFiNE AI 帮助你将想法付诸实践。你也可以像使用 AI 画布 一样生成思维导图,开展头脑风暴。
本地优先,支持实时协作。
< 8000 ul dir="auto">支持自托管,打造自己的 AFFiNE。
- 你可以自由管理、自托管、派生并构建自己的 AFFiNE。插件社区与第三方内容块也在规划中。更多编辑器扩展能力可关注 BlockSuite,部署方式请参阅 AFFiNE 自托管指南。
“我们塑造工具,工具也在塑造我们。”一路走来,许多先行者为我们带来了启发:
- Quip 与 Notion 提出的“一切皆内容块”理念。
- Trello 的看板。
- Airtable 与 Miro 的无代码可编程数据表。
- Miro 与 Whimsical 的无边界可视化白板。
- Remote 与 Capacities 基于对象的标签系统。
这些应用的基础内容块有很多共同之处。我们希望在开源的基础上,提供类似 VS Code 的插件扩展方式,让贡献者能够自由定制,把喜爱的功能整合到一起,并进一步探索新的可能。
感谢你关注 AFFiNE,希望它能与你的工作和创作方式产生共鸣!🎵 更多信息请访问 官方网站。
| 问题报告 | 功能建议 | 提问与讨论 | AFFiNE 社区 |
|---|---|---|---|
| 报告问题 | 提交功能建议 | 参与 GitHub 讨论 | 加入 Discord 社区 |
| 反馈未按预期工作的功能 | 提出新功能或改进想法 | 交流想法、提出问题 | 与其他用户交流、学习和协作 |
欢迎开发者、测试人员、技术文档作者,以及所有愿意参与的朋友!各种形式的贡献都值得欢迎,详情请参阅 贡献类型说明。如果希望贡献代码,请先阅读 贡献指南,再从 GitHub 上的问题列表中选择感兴趣的事项。
开始贡献前,请确认已阅读并接受 贡献者许可协议。编辑该协议文件并提交拉取请求,即表示同意协议。
提交 问题报告、功能请求 或其他 建议 时,也可以 创建新议题,选择最合适的模板填写反馈。
如果希望参与 翻译 和 语言支持,请加入 Discord 社区。
有任何疑问,都欢迎联系我们。Discord 社区 是获取信息、交流经验,以及结识志同道合伙伴的好地方。
AFFiNE 团队提供了一系列开箱即用的 模板。以下是 10 个热门模板,你也可以贡献自己的模板,供其他用户使用。
- 愿景板模板
- 单页文档模板
- 数学教案示例模板
- 渐进式责任转移教学法(GRR)免费教案模板
- 学前班免费可编辑教案模板
- High Note 系列计划本
- 数字计划本
- 注意缺陷多动障碍(ADHD)计划本
- 阅读记录
- 康奈尔笔记模板
欢迎阅读 AFFiNE 官方博客,了解 AFFiNE 与 AFFiNE AI 的使用技巧、实践经验和操作指南,探索更灵活的笔记记录与创意整理方式。
- 愿景板模板
- AI 作业助手
- 愿景板制作工具
- 旅行行程模板
- 单页文档模板
- 康奈尔笔记模板
- 优势、劣势、机会与威胁(SWOT)分析图模板
- 类似 Lunatask 的应用
- AI 笔记:从零散记录到思维导图
- AI 画布
- 单页文档示例与制作方法
- 标准操作流程(SOP)模板
- 家务分工表
| 名称 | 说明 | 项目指标 |
|---|---|---|
| @affine/component | AFFiNE 组件资源 | |
| @toeverything/theme | AFFiNE 主题 |
感谢以下开源项目,它们为 AFFiNE 提供了重要支持:
- BlockSuite:💠 AFFiNE 背后的开源协作编辑器项目。
- y-octo:🐙 原生、高性能、线程安全的 Yjs 无冲突复制数据类型(CRDT)实现,是 AFFiNE 客户端与服务端实现本地优先能力的核心引擎。
- OctoBase:🐙 AFFiNE 背后的开源数据库,兼顾本地优先与协作能力,使用 Rust 编写,是一个轻量、可扩展的数据引擎。
- Yjs:为网页端状态管理与数据同步提供 CRDT 基础支持。
- Electron:使用 JavaScript、HTML 和 CSS 构建跨平台桌面应用。
- React:用于构建网页和原生用户界面的库。
- napi-rs:通过 Node-API 使用 Rust 构建编译型 Node.js 扩展的框架。
- Jotai:基于原子状态、灵活易用的 React 状态管理库。
- async-call-rpc:轻量级 JSON 远程过程调用客户端与服务端。
- Vite:新一代前端构建工具。
- 其他上游 依赖项目。
感谢开源社区提供功能强大、易于使用的库,让我们能够专注于产品逻辑的实现。我们也希望 AFFiNE 能为更多人带来易用的知识管理工具。
感谢每一位为 AFFiNE 作出贡献的朋友!如果你有与 AFFiNE 相关的项目、文档、工具或模板,欢迎提交拉取请求,将其加入 GitHub 上的 AFFiNE 精选资源列表。
使用 Docker 即可部署自己的 AFFiNE 实例,体验丰富的工作空间功能。团队会持续维护和更新版本,具体部署步骤请参阅 自托管文档。
如有新功能建议,请前往 创意讨论区 参与讨论。
在 GitHub 仓库首页点击绿色的“代码”(Code)按钮,然后选择“在 master 分支上创建云端开发环境”(Create codespace on master),即可打开 GitHub Codespaces。该环境会准备仓库副本,并进行项目克隆与构建,供你开始开发。
从源码构建 AFFiNE 的具体步骤,请参阅 构建指南。
欢迎所有人参与贡献,详细步骤请参阅 贡献入门教程。
- AFFiNE 社区版(CE):当前可用的版本,采用 MIT 许可证,可免费自托管。
- AFFiNE 企业版(EE):计划提供更多高级功能与企业服务,包括品牌定制、单点登录(SSO)、高级管理与审计等。更多信息请参阅 定价与版本介绍。
许可证详情请参阅 许可证文件。