从零认识维刻 Vex 的 Flutter 仓库
维刻 Vex:写下想法,看见脉络。
本套文档写给第一次接触 Flutter、第一次打开本仓库的你。先建立地图,再读代码,不需要先认识所有技术名词。
编写日期:2026-10-18。 对照项目版本 0.2.2+4 与当日源码。这里是学习资料,不是“所有平台都已验收完成”的承诺;代码变化后,实际源码、测试和发行产物优先。
1. 你手里其实有四样东西
| 东西 | 在哪里 | 用来做什么 |
|---|---|---|
| 软件源码 | D:\github\apps\Vex-Flutter |
开发者修改 Dart、平台代码和构建脚本 |
| 浏览器原型 | 仓库的 design |
讨论界面和交互,不是实际 Flutter 程序 |
| 安装包与编译输出 | 仓库的 artifacts、应用的 build |
工具生成,供测试或安装 |
| 本套学习笔记 | 仓库的 docs,本机为 D:\github\apps\Vex-Flutter\docs |
随 Git 管理,也可使用 Vex 阅读、修改的普通 Markdown |
安装好的软件是运行工具,.md 是你的内容。二者不应该绑在同一个安装目录里。
2. 建议阅读顺序
| 顺序 | 文档 | 读完能回答的问题 |
|---|---|---|
| 1 | 仓库地图与目录说明 | 为什么有两个 apps?哪些目录不能删? |
| 2 | 需求说明书 | 这个软件给谁用?怎样才算做好? |
| 3 | 概要设计 | 应用、编辑器、核心、导图怎样分工? |
| 4 | 详细设计 | 保存、撤销、恢复、输入、MCP 怎样工作? |
| 5 | 核心原理与源码导读 | Flutter 怎样显示界面?从哪个文件开始读? |
| 6 | 开发调试与测试入门 | 怎样运行、修改、测试第一处代码? |
| 7 | 本机打包安装升级与数据备份 | 怎样双击打包?数据在哪?换机带什么? |
| 8 | Markdown 阅读练习 | 怎样用这些内容体验 Vex 的阅读与编辑? |
进阶连接:MCP 使用与接口指南,包含权限说明、35 个工具和官方 Inspector 测试方法。
完整入口:文档导航,还可找到 更新日志、鸣谢、原型设计 与 打包脚本。文档正文以中文名集中维护,其他目录只保留导航链接;内置文档资源在构建时自动生成。
从 v0.4.0 起可在阅读视图中直接打开相对 .md、.markdown、.txt 链接,也支持 另一篇.md#章节;即时编辑中可通过链接菜单打开。链接相对于当前文档所在目录解析,不会覆盖已打开文档的未保存修改。未保存的草稿和手机系统选择器提供的无路径副本没有可用的相对目录,此时需先保存文档;也可用「打开文件夹」选择本目录,从文件树浏览。
3. 先记住这十个词
| 名词 | 小白版解释 | 在 Vex 中的例子 |
|---|---|---|
| Dart | 写程序使用的语言 | .dart 源文件 |
| Flutter | 用 Dart 构建界面的框架和工具 | 编辑区、对话框、导图界面 |
| SDK | 开发工具箱 | flutter、dart 命令及其运行依赖 |
| Widget | 一个界面描述单元 | 文本、按钮、整页工作区 |
| State | 当前记住的信息 | 当前文档、主题、选区 |
| Controller | 让外部控制某个组件的对象 | 编辑器控制器、导图控制器 |
| ViewModel | 协调界面状态和业务动作的对象 | 打开文件、保存、改变布局 |
| Repository | 统一封装数据存取的接口 | 设置仓库、恢复草稿仓库 |
| Package | 可以被其他代码引用的一组能力 | vex_editor |
| Build | 把源码变成可运行程序 | flutter build windows --release |
不要一开始就背缩写。第一次看不懂是正常的,遇到它时回来查即可。
4. 三种“文档”有什么区别
- 需求文档:说清楚“用户需要什么、怎么验收”。例如自动保存默认关闭。
- 设计文档:说清楚“由哪些模块、通过什么数据流实现”。例如文件服务负责写磁盘,界面不直接操作文件。
- 用户 Markdown:使用软件编辑的内容。例如这篇文章。它不是项目代码,也不自动加入软件安装包。
本套需求、设计文档是对当前实现和已确认产品方向的梳理,不是从零虚构的未来架构。
5. 第一小时可以这样学
- 用 Vex 打开本文件夹,切换源码和阅读视图。
- 读
01,在资源管理器里找到apps/vex/lib/main.dart。 - 读
02,挑三个最关心的用户场景。 - 读
05的启动流程,先不研究编辑器复杂布局。 - 按
06运行一个测试,而不是马上改大功能。 - 按
07找到配置目录,但不修改、不公开里面的令牌。 - 复制
08成为自己的练习稿,再练撤销、表格、图表和导出。
6. 学习时的三个边界
测试通过,不等于所有设备没有问题。 模拟手机尺寸不能替代真实手机;Windows 运行成功不能替代 macOS 验收。
恢复草稿,不等于版本备份。 真正重要的内容仍要保存到
.md,并备份整个笔记和附件目录。
被 Git 忽略,不等于可以删除。
build可以重建;.signing里的发行密钥不可随意重建或丢失。
本套文档与配图 docs/assets 已纳入源码仓库,提交并推送后,换电脑克隆仓库即可取得。尚未提交的练习修改仍需提交或单独备份;用户笔记、配置和签名材料不会因此自动进入 Git。
7. 本次核验范围
2026-10-18:文档已用当前 Markdown 核心解析,并校验相对文件 / 图片链接、Mermaid 场景。还通过真实 Windows Flutter 窗口阅读九篇文档,抽查代码、公式、图片、图表和 390 宽度明暗主题,共保留 19 张截图。
这属于 Windows 原生窗口与手机宽度模拟,不是 iPhone / Android 真机验证;也不代表 PDF / Word 的全部内容已逐页验收。阅读时发现的减少动态效果下图表缩放异常已修复并补充回归测试。
有疑问或建议,欢迎到 GitHub 提交 Issue 参与讨论。