# inbox-pc-sync

**Repository Path**: jjtenger/inbox-pc-sync

## Basic Information

- **Project Name**: inbox-pc-sync
- **Description**: 将webdav中的inbox笔记内容同步到电脑端的markdown文件夹中
- **Primary Language**: Python
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2023-11-24
- **Last Updated**: 2025-06-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# inbox-pc-sync

## 介绍

InboxSync是一个用于同步Inbox笔记的桌面应用程序，支持将WebDAV中的Inbox笔记内容与电脑端文件夹中的Markdown笔记进行双向同步。

## 主要功能

- 通过WebDAV下载最新的Inbox笔记数据，以Markdown格式写入指定电脑文件夹中；
- 将电脑文件夹中的Markdown笔记上传到WebDAV，从而与Inbox APP同步；
- 快速添加新笔记到Inbox中（非Inbox Api模式，所有人都可以用）；
- 下载/上传等支持配置全局快捷键；
- 下载/上传时，支持跳过特定标签的笔记。

## 配置说明

![](assets/image1.png)

- WebDAV服务器地址：您的WebDAV服务器地址（默认坚果云）；
- 用户名：WebDAV服务账号；
- 密码：WebDAV服务授权密码；
- 远程路径：Inbox笔记数据文件在服务器上的路径（默认坚果云中的路径）；
- 本地目录：笔记同步到电脑本地的目录；
- 跳过标签：用逗号分隔的标签列表，例如：#tag1,#tag2/tag3，包含这些标签的笔记在下载/上传时将被跳过；
- 重置同步记录：点击按钮，将清除所有同步状态，下次同步时会重新检查所有文件。

## 使用说明

1. 下载应用程序：[inbox-pc-sync](https://gitee.com/jjtenger/inbox-pc-sync/releases)；
2. 运行应用程序，配置页中配置WebDAV服务账号/授权密码、本地同步目录等，点击“保存配置”；
3. 同步页中，快捷键或者点击“下载”按钮，将最新的Inbox笔记数据下载到本地Markdown文件夹中；
4. 使用Markdown笔记软件（推荐Obsidian）打开Markdown文件夹，可对本地笔记进行增删改查；
5. 同步页中，快捷键或者点击“上传”按钮，将本地Markdown文件夹中的笔记数据上传到WebDAV，并同步到Inbox APP中。

## 使用注意

1. 下载Inbox笔记数据是增量操作，只会上次下载到现在时间内新增或者修改的笔记，需要重新下载全部笔记数据，请到配置页执行“重置同步记录”操作；

2. 上传本地Markdown笔记之前，会检查WebDAV服务中笔记数据是否有更新。如果有更新，应用会提示：“远程有新数据，请先下载更新”。请先执行下载操作，再进行上传，避免数据冲突；

3. 本地Markdown文件夹中，所有笔记会保存在根目录下，不支持子文件夹笔记同步。

4. 同步到电脑本地的Markdown笔记文件结构如下：

![](assets/image.png)

说明如下：

- YAML文档头：
  - inbox_id：对应Inbox中的CardId，请注意，该值不能修改，否则会丢失数据；
  - inbox_published：Inbox笔记的创建时间；
  - inbox_updated：Inbox笔记的编辑时间。
- InboxAssets标题：
  - 该标题下是从Inbox APP中同步过来的当前笔记中的图片、录音、附件等资源；
  - 只供展示，修改无效。也请勿移除InboxAssets标题，防止读取出错。