Obsidian Weread Plugin 下载及安装教程

Obsidian Weread Plugin 下载及安装教程

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 Plugin 是一个社区插件，用于将微信读书中的书籍元信息、高亮标注、划线感想、书评等同步到 Obsidian Vault 中。该插件将这些信息转换为 Markdown 格式保存，方便用户在 Obsidian 中进行笔记管理和知识整理。

2. 项目下载位置

Obsidian Weread Plugin 的项目源码托管在 GitHub 上。用户可以通过以下步骤下载项目：

1. 打开终端或命令行工具。

2. 使用 git clone 命令下载项目：

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

   下载完成后，项目文件将保存在当前目录下的 obsidian-weread-plugin 文件夹中。

3. 项目安装环境配置

3.1 安装 Node.js

Obsidian Weread Plugin 依赖于 Node.js 环境。请确保在安装项目之前已经安装了 Node.js。

1. 访问 Node.js 官方网站下载并安装最新版本的 Node.js。

2. 安装完成后，在终端中运行以下命令验证安装是否成功：

   node -v
   npm -v
   

   如果显示版本号，则说明 Node.js 安装成功。

3.2 安装 Obsidian

Obsidian Weread Plugin 是一个 Obsidian 插件，因此需要先安装 Obsidian 客户端。

1. 访问 Obsidian 官方网站下载并安装 Obsidian。
2. 安装完成后，打开 Obsidian 客户端。

3.3 配置项目环境

1. 进入项目目录：

   cd obsidian-weread-plugin
   

2. 安装项目依赖：

   npm install
   

   此命令将自动安装项目所需的所有依赖包。

4. 项目安装方式

4.1 通过插件市场安装

1. 打开 Obsidian 客户端。
2. 进入“设置” -> “社区插件”。
3. 在搜索框中输入“Weread”，找到“Weread Plugin”并点击“安装”。
4. 安装完成后，点击“启用”使插件生效。

4.2 手动安装

1. 在项目目录中找到 main.js 和 manifest.json 文件。
2. 将这两个文件复制到 Obsidian 的插件目录中。插件目录通常位于 Vault/.obsidian/plugins/ 下。
3. 重新启动 Obsidian 客户端，插件将自动加载。

5. 项目处理脚本

Obsidian Weread Plugin 提供了一些处理脚本，用于同步微信读书中的笔记和标注。以下是一些常用的脚本：

5.1 同步脚本

在项目目录中，运行以下命令以同步微信读书中的笔记：

npm run sync

此命令将自动同步微信读书中的高亮标注和笔记到 Obsidian Vault 中。

5.2 更新脚本

如果需要更新插件，可以运行以下命令：

npm run update

此命令将更新插件到最新版本。

5.3 清理脚本

如果需要清理插件生成的文件，可以运行以下命令：

npm run clean

此命令将删除所有生成的文件，恢复插件的初始状态。

---

通过以上步骤，您可以成功下载、安装并配置 Obsidian Weread Plugin，开始在 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