Obsidian LiveSync 插件安装与配置指南

Obsidian LiveSync 插件安装与配置指南

obsidian-livesync 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-livesync

1. 项目基础介绍和主要编程语言

项目基础介绍

Obsidian LiveSync 是一个社区实现的同步插件，适用于所有兼容 Obsidian 的平台。它使用 CouchDB 或对象存储（如 MinIO、S3、R2 等）作为服务器，实现高效的笔记同步。该插件不支持与官方的 "Obsidian Sync" 同步。

主要编程语言

该项目主要使用以下编程语言和框架：

• TypeScript: 86.5%
• Svelte: 10.1%
• 其他: 3.4%

2. 项目使用的关键技术和框架

关键技术和框架

• CouchDB: 用于数据存储和同步。
• 对象存储: 如 MinIO、S3、R2 等，用于存储数据。
• TypeScript: 用于编写插件的主要逻辑。
• Svelte: 用于构建用户界面组件。

3. 项目安装和配置的准备工作和详细安装步骤

准备工作

1. 安装 Obsidian: 确保你已经在所有设备上安装了 Obsidian 应用。
2. 安装 Node.js: 确保你的系统上已经安装了 Node.js。你可以从 Node.js 官网 下载并安装。
3. 安装 CouchDB: 如果你选择使用 CouchDB 作为服务器，可以从 CouchDB 官网 下载并安装。

详细安装步骤

步骤 1: 克隆项目仓库

首先，克隆 Obsidian LiveSync 项目到你的本地机器：

git clone https://github.com/vrtmrz/obsidian-livesync.git
cd obsidian-livesync

步骤 2: 安装依赖

进入项目目录后，安装项目所需的依赖：

npm install

步骤 3: 配置 CouchDB

如果你选择使用 CouchDB，需要进行以下配置：

1. 启动 CouchDB 服务: 确保 CouchDB 服务已经启动并运行。
2. 创建数据库: 在 CouchDB 中创建一个新的数据库，用于存储笔记数据。

步骤 4: 配置 Obsidian LiveSync 插件

1. 打开 Obsidian: 启动 Obsidian 应用。
2. 启用社区插件: 在 Obsidian 设置中，启用社区插件功能。
3. 安装 LiveSync 插件:
   • 点击左侧的“社区插件”选项。
   • 点击“浏览”按钮，搜索“Self-hosted LiveSync”。
   • 找到并安装“Self-hosted LiveSync”插件。
4. 配置插件:
   • 安装完成后，点击“启用”按钮。
   • 点击“打开设置对话框”按钮。
   • 在设置对话框中，点击带有 🛰️ 卫星图标的按钮。
   • 在“远程类型”下拉菜单中选择“CouchDB”。
   • 在“URI”字段中输入你的 CouchDB 服务器地址，例如 http://localhost:5984/your-database-name。

步骤 5: 启动同步

配置完成后，Obsidian LiveSync 插件将自动开始同步你的笔记。你可以在 Obsidian 的状态栏中查看同步状态。

总结

通过以上步骤，你已经成功安装并配置了 Obsidian LiveSync 插件。现在，你可以享受在多个设备间无缝同步笔记的便利了。

obsidian-livesync 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-livesync