中文文档 | English

中文文档

将 Dinox 笔记同步到 Obsidian，也可以将 Obsidian 笔记推送到 Dinox。

快速开始

1. 在 Obsidian 的 设置 > 第三方插件 中安装并启用本插件
2. 打开插件设置，填入你在 Dinox 应用中获取的 Token
3. 点击底部状态栏的 Dinox 按钮，即可开始同步

就这么简单！笔记会被保存到 Dinox Sync 文件夹中。

核心功能

从 Dinox 同步到 Obsidian（拉取）

每次同步只会拉取上次同步之后有变动的笔记，不会重复下载全部内容。

触发方式：

• 点击底部状态栏的 Dinox 按钮
• 打开命令面板（Ctrl/Cmd + P），搜索「Synchronize Dinox notes now」
• 开启自动同步后，每 30 分钟自动拉取一次

从 Obsidian 推送到 Dinox（推送）

你也可以把本地笔记推送到 Dinox：

推送和创建也可以通过右键菜单或命令面板操作。

文件夹结构

同步后的笔记会按照你的设置，放入不同层级的文件夹中。每一层都是可选的：

Dinox Sync/                        ← 同步目录（可自定义）
 └── note/                         ← 按类型分组（可关闭）
      └── 我的卡片盒/                ← ��卡片盒分组（可关闭）
           └── 2024-03-15/          ← 按日期嵌套（可选择平铺）
                └── 我的笔记.md

下面分别介绍每一层的设置。

同步目录

所有同步的笔记存放在这个文件夹下。

• 设置项： 同步目录
• 默认值： Dinox Sync
• 你可以改成任何你喜欢的名字，比如 笔记/Dinox

按类型分组

Dinox 中的笔记分为两种类型：笔记（自己写的）和素材（网页剪藏的）。开启后，两种类型会分到不同的子文件夹。

• 设置项： 启用按类型分组
• 默认： 开启
• 笔记文件夹： 默认名为 note，可自定义
• 素材文件夹： 默认名为 material，可自定义

注意： 如果你开启了按类型分组，请确保内容模板中包含 {{type}}，否则插件无法区分笔记和素材。

按卡片盒分组

如果你在 Dinox 中使用了「卡片盒」来整理笔记，开启此选项后，笔记会按卡片盒名称再分到对应的子文件夹中。没有分配卡片盒的笔记不受影响，直接留在上一级目录。

• 设置项： 按卡片盒分组
• 默认： 关闭

文件布局

控制笔记是否按日期再分一层子文件夹。

文件命名

你可以选择文件名的生成方式：

自定义文件名模板

选择「自定义模板」后，你可以用以下变量拼出想要的文件名：

示例： 模板 {{title}} ({{createDate}}) 生成 我的笔记 (2024-03-15).md

内容模板

内容模板决定了从 Dinox 拉取的笔记最终在 Obsidian 中呈现的格式，包括 frontmatter 和正文内容。

默认模板：

---
title: {{title}}
noteId: {{noteId}}
type: {{type}}
tags:
{{#tags}}
    - {{.}}
{{/tags}}
zettelBoxes:
{{#zettelBoxes}}
    - {{.}}
{{/zettelBoxes}}
audioUrl: {{audioUrl}}
createTime: {{createTime}}
updateTime: {{updateTime}}
---
{{#audioUrl}}
![录音](https://raw.githubusercontent.com/ryzencool/dinox-sync/HEAD/{{audioUrl}})
{{/audioUrl}}

{{content}}

你可以根据需要自由修改这个模板。模板采用 Mustache 语法，{{#tags}}...{{/tags}} 表示循环渲染每个标签。

日记集成

开启后，每次同步会自动在对应日期的日记中添加当天同步笔记的链接。需要 Obsidian 核心插件「日记」处于启用状态。

保护本地修改

忽略同步

如果你在本地修改了某篇同步笔记，不希望它被下次同步覆盖，可以在该笔记的 frontmatter 中添加：

ignore_sync: true

这样插件在同步时会跳过这篇笔记。属性名可以在设置中自定义（默认为 ignore_sync）。

保留属性

如果你在同步笔记上手动添加了一些 frontmatter 属性（比如 status、aliases、project），希望同步更新时保留这些属性不被覆盖，可以在设置中的「保留属性」填入这些属性名，用逗号或换行分隔。

示例： 填入 status, aliases, project，这三个属性在同步更新时会从旧文件中保留。

快捷键

你可以在插件设置的「快捷键」区域为以下操作设置自定义快捷键：

点击「设置」按钮后按下你想要的快捷键组合即可绑定。

重置同步

如果你想重新拉取所有笔记（比如修改了模板或文件夹设置），可以在设置最下方的「重置同步状态」区域选择时间范围后点击重置。下次同步时会重新拉取该时间段之后的所有笔记。

自动同步

开启后，插件会每 30 分钟自动同步一次，不需要手动操作。

• 设置项： 启用自动同步
• 默认： 关闭

命令一览

在 Obsidian 命令面板（Ctrl/Cmd + P）中可以找到以下命令：

隐私与网络访问

本插件需要 Dinox 账号 Token 才能完整使用。Token 保存在 Obsidian 插件设置数据中，不会写入同步笔记。插件会访问 dinoai.chatgo.pro 拉取笔记，并访问 aisdk.chatgo.pro 创建或更新 Dinox 笔记；除此之外不包含客户端遥测、广告或自动更新机制。

支持

如果遇到问题或有建议，请到 GitHub Issues 反馈，或发送邮件到 [email protected]。

English

Sync notes between Dinox and your Obsidian vault. Pull notes from Dinox into Obsidian, and push local notes back to Dinox.

Getting Started

1. Install and enable this plugin from Settings > Community plugins
2. Open the plugin settings and enter the Token from the Dinox app
3. Click the Dinox button in the status bar to start syncing

That's it! Notes will be saved to the Dinox Sync folder by default.

Core Features

Pull from Dinox to Obsidian

Each sync only fetches notes that changed since the last sync — no redundant downloads.

How to trigger:

• Click the Dinox button in the bottom status bar
• Open the command palette (Ctrl/Cmd + P) and search for "Synchronize Dinox notes now"
• Enable auto sync to pull automatically every 30 minutes

Push from Obsidian to Dinox

You can also push local notes to Dinox:

All actions are also available via the right-click menu and command palette.

Folder Structure

Synced notes are organized into folders based on your settings. Each layer is optional:

Dinox Sync/                        ← Sync directory (customizable)
 └── note/                         ← Type-based grouping (can be disabled)
      └── My Zettel Box/           ← Zettel box grouping (can be disabled)
           └── 2024-03-15/          ← Date nesting (can use flat layout)
                └── My Note.md

Sync Directory

The root folder for all synced notes.

• Setting: Sync directory
• Default: Dinox Sync
• You can change it to any name you like, e.g. Notes/Dinox

Type-Based Folders

Dinox notes come in two types: notes (written by you) and materials (web clippings). When enabled, each type gets its own subfolder.

• Setting: Split by type
• Default: Enabled
• Note folder: Default note, customizable
• Material folder: Default material, customizable

Note: If you enable type-based folders, make sure your content template includes {{type}}. Otherwise the plugin cannot distinguish notes from materials.

Zettel Box Folders

If you use zettel boxes in Dinox to organize notes, enabling this option creates subfolders named after each zettel box. Notes without a zettel box stay in the parent folder.

• Setting: Group by zettel box
• Default: Disabled

File Layout

Controls whether notes are further grouped by date.

File Naming

Choose how filenames are generated:

Custom Filename Template

When using "Custom template", these variables are available:

Example: Template {{title}} ({{createDate}}) produces My Note (2024-03-15).md

Content Template

The content template controls how notes from Dinox are formatted in Obsidian, including frontmatter and body content.

Default template:

---
title: {{title}}
noteId: {{noteId}}
type: {{type}}
tags:
{{#tags}}
    - {{.}}
{{/tags}}
zettelBoxes:
{{#zettelBoxes}}
    - {{.}}
{{/zettelBoxes}}
audioUrl: {{audioUrl}}
createTime: {{createTime}}
updateTime: {{updateTime}}
---
{{#audioUrl}}
![录音](https://raw.githubusercontent.com/ryzencool/dinox-sync/HEAD/{{audioUrl}})
{{/audioUrl}}

{{content}}

You can customize this template freely. It uses Mustache syntax — {{#tags}}...{{/tags}} loops over each tag.

Daily Notes Integration

When enabled, each sync automatically adds links to synced notes in the corresponding daily note. Requires the Obsidian core "Daily notes" plugin to be active.

Protecting Local Changes

Ignore Sync

If you've edited a synced note locally and want to prevent the next sync from overwriting it, add this to the note's frontmatter:

ignore_sync: true

The plugin will skip this note during sync. The property name is customizable in settings (default: ignore_sync).

Preserve Properties

If you've added custom frontmatter properties to synced notes (like status, aliases, project) and want them to survive sync updates, list them in the "Preserve property keys" setting, separated by commas or newlines.

Example: Enter status, aliases, project — these three properties will be carried over when the note is updated by sync.

Hotkeys

You can set custom hotkeys for the following actions in the plugin settings under "Hotkeys":

Click "Set", then press your desired key combination to bind it.

Reset Sync

If you want to re-fetch notes (e.g., after changing the template or folder settings), use the "Reset sync state" option at the bottom of the settings. Choose a time range and click reset. The next sync will re-fetch all notes from that point onward.

Auto Sync

When enabled, the plugin automatically syncs every 30 minutes.

• Setting: Enable auto sync
• Default: Disabled

Commands

Available in the Obsidian command palette (Ctrl/Cmd + P):

Privacy and network access

This plugin requires a Dinox account token for full functionality. The token is stored in Obsidian plugin settings data and is not written into synced notes. The plugin connects to dinoai.chatgo.pro to pull notes, and to aisdk.chatgo.pro to create or update Dinox notes. It does not include client-side telemetry, ads, or a self-update mechanism.

Support

If you encounter issues or have suggestions, please open an issue on GitHub or email [email protected].

License

This plugin is licensed under the MIT License.