obsidian-shiki-plugin 的安装和配置教程

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

obsidian-shiki-plugin 是一个为 Obsidian 编辑器开发的插件，它提供了语法高亮的功能，可以增强 Markdown 文档的可读性。该插件主要使用 JavaScript 进行开发，这是开发 Obsidian 插件的标准语言。

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

本项目使用的关键技术包括：

• Obsidian 插件API：用于开发与 Obsidian 编辑器集成的插件。
• Shiki：一个快速的语法高亮库，用于实现代码的语法高亮显示。

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

准备工作

在开始安装 obsidian-shiki-plugin 插件之前，请确保您已经满足以下条件：

• 安装了 Obsidian 编辑器。
• 确保您的计算机上已经安装了 Node.js 环境，因为插件可能需要使用它来编译资源。

安装步骤

1. 克隆项目仓库
   打开命令行工具，执行以下命令克隆项目仓库到本地：

   git clone https://github.com/mProjectsCode/obsidian-shiki-plugin.git
   

2. 安装依赖
   进入克隆后的项目目录，使用以下命令安装项目依赖：

   npm install
   

3. 构建插件
   在项目目录中，执行以下命令来构建插件：

   npm run build
   

4. 复制插件文件
   构建完成后，将 dist 目录中的插件文件（通常是 main.js 和 styles.css）复制到 Obsidian 的插件文件夹中。通常，这个文件夹位于 ~/.obsidian/plugins/ 路径下（在 Windows 系统中，可能是 C:\Users\你的用户名\AppData\Roaming\obsidian\plugins）。

5. 重启 Obsidian
   复制完文件后，重启 Obsidian 编辑器，新的语法高亮插件应该已经出现在插件列表中。

6. 启用插件
   在 Obsidian 的插件管理器中找到 obsidian-shiki-plugin，并启用它。

7. 配置插件
   启用插件后，可能需要通过插件的设置界面进行一些配置，例如选择要高亮的编程语言和主题样式。

完成以上步骤后，您的 Obsidian 编辑器就应该可以享受 obsidian-shiki-plugin 提供的语法高亮功能了。