# Obsidian 同步插件

Cubox 官方 Obsidian 同步插件支持你将 Cubox 中的文章或标注同步到 Obsidian。

# 下载与安装

内测阶段，请参考如下步骤安装

访问链接 GitHub Releases (opens new window) 下载最新版本的 main.js、manifest.json 和 styles.css 这三个文件，并放入名为 obsidian-cubox 的文件夹备用；
进入 Obsidian 的扩展目录（在当前 Vault 目录的 .obsidian/plugins 位置，也可以通过 Obsidian 设置 - Community plugins - Installed plugins 右侧的文件夹图标进入），将上一步的文件夹放到该位置中；
回到 Obsidian，点按上一步骤相同设置页面的刷新按钮，即可看到 Cubox 扩展，启用开关，点按齿轮按钮进入配置。

# 连接 Obsidian 与 Cubox

# 选择 Cubox 服务器

选择您使用的 Cubox 服务器域名（当前文档所对应的服务为 cubox.pro）

# 获取 API Key

进入Cubox 网页版设置 - 扩展中心和自动化 (opens new window)
在 “API 扩展” 中启用并复制 API 链接，粘贴到 Obsidian 插件设置中

# 筛选同步数据范围

Cubox 会默认同步所有包含解析内容的数据，但我们建议您通过配置要同步的收藏夹、标签、类型和卡片状态来选择同步最重要的信息。

更改选择后，只有同时符合这四个选项的数据才会被同步。比如：你可以只选择同步某个重要收藏夹中，有标注且已读的项目。这样，那些还没完成标注，还没阅读过的内容不会因为很早被同步完成而无法获得标注的更新。

# 配置同步方式

设定自动同步的时间间隔（以分钟为单位），建议设置为 0 使用手动同步，或设置较长间隔时间，这样可以避免内容被过早同步。

# 文件名模板

内容同步到 Cubox 时，每个笔记的文件名可自定义。可用变量：


{{{title}}} //卡片标题
{{{article_title}}} //文章内容标题
{{{create_time}}} //收藏日期
{{{update_time}}} //更新日期
{{{domain}}} //来源网站主域名
{{{type}}} //内容的类型名称，如文章、片段...

# 默认模板


{{{card_title}}}-{{{create_time}}}

# 元属性

用于存储文章的关键属性信息，可自定义需要包含哪些字段。可用变量：


title //卡片标题
article_title //文章内容标题
tags //文章标签
create_time //收藏时间
update_time //更新时间
domain //来源网站主域名
url //来源链接
cubox_url //Cubox 深度链接
description //卡片描述
words_count //内容总词数
type //内容的类型名称，如文章、片段...

# 默认变量


cubox_url, original_url, tags

注意：无论如何设置元数据变量，会始终包含 id，用于比对数据同步情况，请勿修改或删除。

# 内容模板

自定义同步到每个笔记的内容以及展示格式。可用变量：


{{{id}}} //唯一标识符
{{{title}}} //卡片标题
{{{description}}} //卡片描述
{{{article_title}}} //文章内容标题
{{{content}}} //文章正文
{{{content_highlighted}}} //文章正文包含高亮标记
{{{highlights}}} //所有标注（包含高亮和笔记）
 {{{highlight_text}}} //高亮的文本
  {{{image_url}}} //高亮图片链接
  {{{cubox_url}}} //高亮 Cubox 深度链接
  {{{note}}} //高亮笔记文本
  {{{color}}} //高亮颜色
  {{{create_time}}} //高亮创建时间
{{{tags}}} //文章标签
{{{update_time}}} //更新时间
{{{domain}}} //来源网站主域名
{{{url}}} //来源链接
{{{cubox_url}}} //Cubox 深度链接
{{{words_count}}} //内容总词数

# 默认模板

该模板用于同步每张卡片的标题、描述等基本信息，以及对应的标注，不包含文章正文。

每个 Cubox 卡片可以同步为一个 Obsidian 笔记，你可以按需配置要同步的正文、高亮等内容，或正文与高亮的组合。


# {{{title}}}

{{{description}}}

[Read in Cubox]({{{cubox_url}}})  
[Read Original]({{{url}}})  

---

{{#highlights.length}}
## Annotations  

{{#highlights}}
> {{{text}}}  

{{#note}}
{{{note}}}
{{/note}}
[Link️]({{{cubox_url}}})  

{{/highlights}}
{{/highlights.length}}

# 日期格式

指定以上任何模板中使用的日期的统一格式。推荐的常用格式如下：

yyyy-MM-dd
MM/dd/yyyy
dd.MM.yyyy
yyyy-MM-dd HH:mm:ss

更多自定义格式参考 (opens new window)

# 同步说明

点击 Obsidian 界面的 Cubox 扩展图标，可执行手动同步，若设置了同步间隔，插件将定期自动拉取最新收藏的文章。
每个 Cubox 内容，在一个 Obsidian 的文件夹位置仅同步一次，后续 Cubox 的更新不会再被同步，除非在 Obsidian 中删除了原内容，变更了内容的 id 信息，或在 Obsidian 设置中修改了目标文件夹。修改或删除每个同步的笔记顶部的 id 属性可能会导致同步出错，请不要随意操作。
每个 Cubox 内容会在 Obsidian 中同步为一个笔记，你可以通过模板设置要同步正文内容、高亮内容或不同内容的组合。

← 复制和导出内容桌面小组件 →