【亲测免费】 Obsidian Custom Frames 插件技术文档

Obsidian Custom Frames 插件技术文档

1. 安装指南

1.1 安装步骤

1. 打开 Obsidian 应用。
2. 进入“设置” > “社区插件” > “浏览”。
3. 在搜索栏中输入“Custom Frames”。
4. 找到“Obsidian Custom Frames”插件并点击“安装”。
5. 安装完成后，点击“启用”。

1.2 更新插件

1. 进入“设置” > “社区插件”。
2. 找到“Obsidian Custom Frames”插件，点击“检查更新”。
3. 如果有更新，点击“更新”按钮。

2. 项目的使用说明

2.1 基本使用

1. 安装并启用插件后，进入插件设置。
2. 点击“添加新框架”，选择预设或自定义框架。
3. 根据需要调整框架的样式和设置。

2.2 框架模式

• 命令模式：使用“Custom Frames: Open”命令打开自定义框架。
• Markdown模式：在Markdown文档中使用特殊代码块语法嵌入自定义框架。

2.3 移动端使用

• 由于Obsidian移动端不支持Electron，部分网站可能无法正常显示。
• 可以在创建框架时启用“Disable on Mobile”选项，隐藏桌面端专用框架。

3. 项目API使用文档

3.1 添加自定义框架

• 命令：Custom Frames: Open
• 参数：
  • frameName：框架名称
  • style：自定义样式
  • urlSuffix：URL后缀

3.2 Markdown代码块语法

frame: YOUR FRAME'S NAME
style: height: 1000px;
urlSuffix: #reminders

4. 项目安装方式

4.1 通过Obsidian社区插件安装

• 进入Obsidian设置，搜索并安装“Custom Frames”插件。

4.2 手动安装

1. 下载插件的最新版本。
2. 将插件文件夹放入Obsidian的插件目录。
3. 在Obsidian中启用插件。

通过以上步骤，您可以顺利安装并使用Obsidian Custom Frames插件，享受自定义框架带来的便利。