Obsidian Weread 插件安装与配置指南

Obsidian Weread 插件安装与配置指南

obsidian-weread-plugin Obsidian Weread Plugin is a plugin to sync Weread(微信读书) hightlights and annotations into your Obsidian Vault. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-weread-plugin

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

Obsidian Weread 插件是一个用于将微信读书（Weread）中的高亮标注和笔记同步到 Obsidian Vault 的社区插件。该项目的主要编程语言是 TypeScript，同时也使用了 JavaScript、HTML 和 Nunjucks 等技术。

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

• TypeScript: 主要编程语言，用于编写插件的核心逻辑。
• JavaScript: 用于处理一些动态交互和逻辑。
• HTML: 用于构建用户界面。
• Nunjucks: 一个模板引擎，用于生成笔记内容。
• Obsidian API: 用于与 Obsidian 笔记应用进行交互。

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

准备工作

1. 安装 Obsidian: 确保你已经在本地安装了 Obsidian 笔记应用。
2. 创建 Vault: 在 Obsidian 中创建一个新的 Vault（笔记库），或者使用现有的 Vault。
3. 安装 Node.js: 确保你的系统中已经安装了 Node.js，因为插件的安装和运行需要 Node.js 环境。

详细安装步骤

步骤 1：克隆项目仓库

首先，打开终端或命令行工具，导航到你希望存放项目的目录，然后执行以下命令克隆项目仓库：

git clone https://github.com/zhaohongxuan/obsidian-weread-plugin.git

步骤 2：安装依赖

进入克隆的项目目录，并安装项目所需的依赖：

cd obsidian-weread-plugin
npm install

步骤 3：构建插件

在项目目录中运行以下命令来构建插件：

npm run build

步骤 4：安装插件到 Obsidian

1. 打开 Obsidian 应用，进入你创建的 Vault。
2. 点击左侧边栏的“设置”图标，进入设置页面。
3. 在设置页面中，找到“社区插件”选项，点击“浏览”按钮。
4. 在社区插件市场中搜索“Weread”，找到 Weread Plugin 并点击“安装”。
5. 安装完成后，点击“启用”按钮以启用插件。

步骤 5：配置插件

1. 在 Obsidian 中，点击左侧边栏的“设置”图标，进入设置页面。
2. 找到“Obsidian Weread Plugin”选项，进入插件设置页面。
3. 点击右侧的“登录”按钮，在弹出的登录页面中使用微信扫码登录。
4. 登录完成后，设置笔记保存位置、笔记最小划线数量、笔记文件夹分类等选项。

步骤 6：使用插件

1. 点击左侧边栏的微信读书按钮，或者使用快捷键 Command+P（Windows 上是 Ctrl+P）调出命令面板。
2. 输入“Weread”，找到“Sync Weread”命令并执行，即可同步微信读书中的高亮标注和笔记到 Obsidian Vault。

注意事项

• 插件是覆盖式更新，请不要在同步的文件里修改内容，写永久笔记时可以使用 Block 引用的方式进行批注。
• 长期不使用插件可能导致 Cookie 失效，需要重新登录。
• 偶尔可能会有网络连接问题，重新点击同步即可，已同步的笔记不会再次更新。

通过以上步骤，你就可以成功安装并配置 Obsidian Weread 插件，将微信读书中的笔记同步到 Obsidian 中。

obsidian-weread-plugin Obsidian Weread Plugin is a plugin to sync Weread(微信读书) hightlights and annotations into your Obsidian Vault. 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-weread-plugin