Skip to content

giraffe-tree/flomo-bridge

Repository files navigation

Flomo Bridge

flomo 笔记桥接到 Obsidian 的插件。

最新版本

  • 1.0.5

功能特性

  • 增量同步 - 只同步新增/修改的笔记,避免重复写入
  • 全量同步 - 支持重置游标重新同步所有笔记
  • 自动同步 - 支持定时自动同步(10s/1分钟/10分钟/1小时自动更新)
  • 附件下载 - 自动下载图片和音频附件到本地
  • 反向链接 - 自动将 flomo memo 互引链接转换为 Obsidian 内部链接
  • 清理已删除 - 同步时自动清理服务端已删除的本地笔记及附件
  • 状态栏 - 显示最近同步时间和进度
  • 本地存储 - Token 和数据仅保存在本地,不上传任何服务器

配置展示页面

setup

安装方法

1) 从 GitHub Release 手动安装(推荐)

  1. 打开 Releases 页面
  2. 下载以下三个文件:main.jsmanifest.jsonstyles.css
  3. 在 vault 中创建插件目录并放入这三个文件:
{你的 Obsidian vault}/.obsidian/plugins/flomo-bridge/
├── main.js
├── manifest.json
└── styles.css
  1. 重启 Obsidian 或按 Cmd/Ctrl + P 执行 Reload app without saving
  2. 设置 → 第三方插件 启用 "Flomo Bridge"

2) 从源码构建(可选)

npm install
npm run build

构建完成后,将以下文件复制到 {你的 Obsidian vault}/.obsidian/plugins/flomo-bridge

  • main.js
  • manifest.json
  • styles.css

配置说明

1. 获取 Flomo Token

  1. 点击打开 v.flomoapp.com/mine 并登录 flomo
  2. F12 打开开发者工具 → 切换到 Network 标签
  3. 刷新页面或点击任意笔记,找到一个 API 请求(如 momouser
  4. 在 Request Headers 中找到 Authorization,复制 Bearer 后面的 token 值

Token 获取示意图

说明:上图用于仓库文档预览;插件运行时会读取 vault 内 .obsidian/plugins/flomo-bridge/img/start_setup.gif

💡 提示: Token 格式类似 1023456|AA000000...,直接粘贴即可,插件会自动处理 Bearer 前缀

2. 设置目标目录

默认同步到 flomo/Inbox 目录,可以根据需要修改。

3. 其他选项

选项 说明
下载附件 是否自动下载图片和音频到本地
自动同步间隔 设置自动同步频率,设为"禁用"则关闭自动同步
启用反向链接转换 将 flomo memo 互相引用的外部链接自动转换为 Obsidian 反向链接(Wikilink 或 Markdown 格式)
调试模式 在控制台输出详细日志

使用方法

命令面板

Cmd/Ctrl + P 打开命令面板,输入 "Flomo":

  • Flomo: Sync now - 执行增量同步
  • Flomo: Sync full - 执行全量同步
  • Flomo: Repair backlinks & cleanup deleted memos - 修复反向链接并清理本地已删除记录
  • Flomo: Open settings - 打开设置面板

状态栏

点击状态栏的 Flomo 图标可以打开设置面板。

同步产物格式

每条 flomo 笔记会生成一个独立的 Markdown 文件:

---
slug: MTI3MTMwMzQ0
created_at: "2024-07-11 00:20:04"
updated_at: "2024-07-11 00:20:04"
deleted_at: ""
tags: ["英语/如何学习"]
source: "android"
---

#英语/如何学习

你不是学不会,你只是不学

**附件:**
![photo.png](attachments/2024/07/11/MTI3MTMwMzQ0_photo.png)

文件名格式:{日期}_{标签}_{内容摘要}_{slug}.md

文件结构

flomo
├── 2024-01-01_标签_摘要_slug1.md
├── 2024-01-02_标签_摘要_slug2.md
└── attachments/
    └── 2024/
        └── 01/
            └── 01/
                └── slug_filename.png

增量同步原理

  1. 首次同步时,全量拉取所有笔记
  2. 记录上次同步的最大 updated_at 时间戳
  3. 下次同步时,从该时间点开始拉取(减去1天容错)
  4. 根据 slug 去重,避免重复写入同一笔记
  5. 检测服务端已删除的笔记,同步清理本地对应文件及附件

常见问题

Q: 同步失败提示 "签名错误"

A: Token 无效或已过期,请重新获取并配置。

Q: 如何重新同步所有笔记?

A: 在设置面板点击"全量同步"按钮,或执行 "Flomo: Sync Full" 命令。

Q: 附件下载失败怎么办?

A: 检查网络连接,或在设置中关闭"下载附件"选项,保留远程链接。

Q: 同步会删除本地笔记吗?

A: 会。如果笔记在 flomo 服务端已被删除,同步时会自动删除本地对应文件及其附件。你也可以在设置面板手动执行"修复"来清理所有远程已不存在的本地记录。

Q: 如何查看调试日志?

A: 在设置中开启"调试模式",然后按 Cmd/Ctrl + Shift + I 打开开发者工具查看 Console。

开发

# 安装依赖
npm install

# 开发模式(自动重编译)
npm run dev

# 生产构建
npm run build

# 版本更新(同步 manifest.json 和 versions.json)
npm version patch

# 发布到 GitHub Release
npm run release

技术说明

  • 基于 Obsidian API 和 TypeScript 开发
  • 使用 requestUrl 进行网络请求(支持跨域)
  • MD5 签名算法完全兼容 flomo 官方 API
  • 所有数据本地存储,无云端依赖

License

MIT

About

将 flomo 笔记桥接到 Obsidian 的插件

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages