Obsidian Iconize 项目常见问题解决方案

项目基础介绍

Obsidian Iconize 是一个为 Obsidian 笔记应用开发的插件，旨在帮助用户在笔记中添加自定义图标。该插件支持多种图标格式，包括 SVG 图标，并提供了丰富的功能，如在文件名、笔记标题、标签等位置添加图标，以及支持自定义图标包和颜色设置。Obsidian Iconize 的主要编程语言是 JavaScript，使用了 TypeScript 进行开发，并依赖于 Rollup 进行打包。

新手使用注意事项及解决方案

1. 安装依赖时遇到问题

问题描述： 新手在克隆项目并尝试安装依赖时，可能会遇到 pnpm 或其他依赖管理工具的安装问题。

解决步骤：

1. 确保已安装 pnpm，可以通过命令 npm install -g pnpm 进行全局安装。
2. 克隆项目后，进入项目目录并运行 pnpm install 安装所有依赖。
3. 如果仍然遇到问题，可以尝试使用 npm install 或 yarn install 替代 pnpm install。

2. 配置 env.js 文件时路径错误

问题描述： 在配置 env.js 文件时，指定的 Obsidian 插件目录路径可能不正确，导致插件无法正常加载。

解决步骤：

1. 在项目根目录下创建 env.js 文件。
2. 确保路径格式正确，例如：export const obsidianExportPath = '<path-to-obsidian-vault>/obsidian/plugins/obsidian-iconize/'。
3. 确保指定的目录存在，如果不存在，手动创建该目录。
4. 重新运行 pnpm dev 启动开发服务器。

3. 图标无法显示或显示异常

问题描述： 在笔记中添加图标后，图标无法显示或显示异常，可能是由于图标路径或格式问题。

解决步骤：

1. 确保使用的图标是 SVG 格式，并且路径正确。
2. 检查图标文件是否放置在正确的目录下，通常建议将图标文件放在 iconPacks 目录中。
3. 在 Obsidian 设置中，确认插件已启用，并且图标设置正确。
4. 如果问题仍然存在，尝试重新启动 Obsidian 应用，或者重新加载插件。

通过以上步骤，新手用户可以更好地理解和使用 Obsidian Iconize 插件，解决常见问题，提升使用体验。