Obsidian-Shiki-Plugin 使用教程

1. 项目介绍

Obsidian-Shiki-Plugin 是一个为 Obsidian 编辑器设计的插件，它能够为 Markdown 文本添加语法高亮功能。该插件基于 Shiki 字体高亮引擎，支持多种编程语言的语法高亮显示，使得代码在 Markdown 文档中更加易于阅读和理解。

2. 项目快速启动

首先，确保您已经安装了 Obsidian 编辑器。以下是快速启动该插件的步骤：

# 克隆项目到本地
git clone https://github.com/mProjectsCode/obsidian-shiki-plugin.git

# 进入项目目录
cd obsidian-shiki-plugin

# 安装依赖
npm install

# 运行插件
npm run dev

在运行以上命令后，插件将在开发模式下启动，并在 Obsidian 编辑器中生效。

3. 应用案例和最佳实践

• 代码高亮显示：在 Markdown 文档中，使用 language 包裹代码块，其中 language 是你希望高亮的编程语言。例如，对于 Python 代码：

  ```python
  def hello_world():
      print("Hello, World!")
  

• 自定义语言支持：如果插件不支持你使用的编程语言，可以自定义语言配置文件，增加语言支持。

• 性能优化：如果文档中包含大量代码块，考虑分批次加载语法高亮，以提高页面加载速度。

4. 典型生态项目

• Shiki: Shiki 是一个基于 Web 的字体高亮引擎，Obsidian-Shiki-Plugin 就是基于这个引擎开发而成。
• Obsidian: Obsidian 是一个强大的知识库应用，支持 Markdown 格式，用户可以创建、链接和查找笔记。
• 社区插件: Obsidian 社区开发了众多插件，例如主题插件、图数据库插件等，极大地扩展了 Obsidian 的功能。

以上就是 Obsidian-Shiki-Plugin 的使用教程，希望对您有所帮助！