Obsidian Folder Notes 插件技术文档

Obsidian Folder Notes 插件技术文档

1. 安装指南

1.1 下载插件

要安装 Obsidian Folder Notes 插件，请按照以下步骤操作：

1. 打开 Obsidian 应用。
2. 进入插件市场，点击 https://obsidian.md/plugins?id=folder-notes。
3. 在插件页面中，点击“安装”按钮。

1.2 启用插件

安装完成后，您需要在 Obsidian 中启用该插件：

1. 打开 Obsidian 设置。
2. 导航到“社区插件”部分。
3. 找到“Folder Notes”插件并启用它。

2. 项目使用说明

2.1 基本功能

Folder Notes 插件允许您将笔记附加到文件夹中，这样您可以通过点击文件夹名称来打开笔记，类似于 Notion 应用中的功能。

2.2 高级功能

• 路径打开: 通过文件路径点击文件夹名称来打开笔记。
• 自动创建: 为每个现有文件夹自动创建笔记。
• 模板支持: 支持使用模板创建笔记。

2.3 使用示例

假设您有一个名为“项目A”的文件夹，您可以创建一个名为“项目A.md”的笔记文件，并将其放置在“项目A”文件夹中。这样，当您点击“项目A”文件夹时，Obsidian 将自动打开“项目A.md”笔记。

3. 项目API使用文档

3.1 命令调用

Folder Notes 插件提供了多个命令，您可以通过命令面板调用这些命令：

• 打开文件夹笔记: 通过文件路径或文件夹名称打开笔记。
• 创建文件夹笔记: 为选定的文件夹创建一个新的笔记。

3.2 配置选项

您可以在插件设置中配置以下选项：

• 自动同步文件夹名称: 自动将笔记文件名与文件夹名称同步。
• 排除文件夹: 使用正则表达式排除特定文件夹。

4. 项目安装方式

4.1 手动安装

如果您无法通过 Obsidian 插件市场安装，可以手动安装插件：

1. 从 GitHub 仓库下载插件文件。
2. 将下载的文件解压到 Obsidian 的插件目录中。
3. 在 Obsidian 中启用插件。

4.2 更新插件

要更新插件，请按照以下步骤操作：

1. 在 Obsidian 插件市场中找到 Folder Notes 插件。
2. 点击“更新”按钮。

通过以上步骤，您可以顺利安装、使用和更新 Obsidian Folder Notes 插件。