Obsidian 插件：【Readme】Syncthing Integration

概述

Obsidian 中的 Syncthing 集成。

Readme(翻译）

下面是 syncthing-integration 插件的自述翻译

Obsidian Syncthing集成

该插件允许您使用 Syncthing 将 Obsidian vault 与远程设备同步。

:label: 徽章

[][discussions]

:link: 有用的链接

相关软件

• Syncthing
• Obsidian

插件相关链接

• 路线图
• [GH 讨论][discussions]

:arrow_down: 安装

您可以使用以下方式安装插件：

• 从 Obsidian 的社区插件选项卡中安装
• 从 GitHub 的 发布页面 安装
• 从源代码安装，请参阅 开发部分
• 使用 Obsidian42 BRAT 安装

指南

安装插件的最佳方法是通过 Obsidian 社区插件选项卡。您可以在 这里 找到如何操作的指南。

否则，您可以从 GitHub 的 发布页面 下载最新版本。然后，您可以通过下载 main.js、manifest.json 和 styles.css 文件并将它们放置在您的 vault 的 .obsidian/plugins/obsidian-syncthing-integration 文件夹中手动安装插件。

如果您想从源代码安装插件，请参阅 开发部分。

最后，您可以使用 Obsidian42 BRAT 安装插件，并提供 GitHub 存储库的 URL。请参阅 BRAT文档。

:wrench: 配置

:construction: 此插件仍在开发中。配置可能尚未完全可用。:construction:

该插件应该可以直接使用，但您可以通过进入插件设置来进行配置。该插件的主要目标是在 Obsidian 应用程序中提供 SyncThing 功能的完整集成。因此，您不必依赖其他应用程序来同步您的保险库。您只需在要同步的设备上打开 Obsidian 应用程序，插件将负责其余的工作。

集成将使用 CLI 或 REST API 与 Syncthing 进行交互。主要目标是从 Obsidian 应用程序处理所有保险库同步过程。因此，您不必在设备上打开 Syncthing 应用程序来同步您的保险库。

但是，它不旨在管理与 Syncthing 同步的多个文件夹。想要通过 Syncthing 同步其他文件夹，请随意进行同步，但插件只会管理保险库文件夹。所有插件功能仅适用于保险库文件夹（用于冲突/差异模态和设置）。

:heart: 贡献

要为这个插件做贡献，您可以在 GitHub 上创建 问题 和 拉取请求。此外，您可以在 讨论标签 中讨论任何新的想法或建议。

在为该项目做贡献时，请遵守 行为准则 并阅读 贡献指南。

:hammer_and_wrench: 开发

如果您想在本地开发此插件，请按照以下说明进行操作。

1. 克隆存储库
2. 使用 pnpm install 安装依赖项
3. 使用 pnpm dev 构建插件
4. （可选）在 Obsidian 中使用 hot-reload 插件 在您进行更改时自动重新加载插件

:clap: 鸣谢

以下是本插件的一些灵感来源：

• Obsidian版本历史差异 by kometenstaub - 鸣谢：
  • styles.scss 文件，
  • 相应的 esbuild SCSS/CSS 配置，
  • 以及解决文件冲突时差异模态框布局的整体灵感。
• Obsidian测试库 by pedersen - 鸣谢：
  • 插件的开发模式功能。我添加了一个开发模式模态框，以便轻松生成带有 syncthing 冲突格式的测试文件。

:busts_in_silhouette: 作者

• @LBF38

:sparkles: 贡献者

:memo: 许可证

本项目使用 MIT 许可证。有关更多信息，请参阅 LICENSE。