Obsidian Note From Template 插件安装与配置指南

Obsidian Note From Template 插件安装与配置指南

obsidian-note-from-template Simple plugin to create Notes from a template, and fill in fields defined there 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-note-from-template

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

Obsidian Note From Template 是一个为 Obsidian 笔记软件开发的插件，旨在通过模板快速创建笔记。该插件允许用户定义模板文件，并通过简单的命令从这些模板生成新的笔记。主要编程语言为 JavaScript，使用了 TypeScript 进行开发。

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

• JavaScript/TypeScript: 项目的主要编程语言，用于实现插件的核心功能。
• Obsidian API: 用于与 Obsidian 笔记软件进行交互，实现插件的功能。
• Mustache 模板引擎: 用于在模板中插入变量和逻辑，生成动态内容。
• YAML: 用于定义模板的前置元数据，配置模板的行为和属性。

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

准备工作

1. 安装 Obsidian: 确保你已经在本地安装了 Obsidian 笔记软件。
2. 启用第三方插件: 在 Obsidian 设置中，启用第三方插件功能。

详细安装步骤

1. 下载插件:

   • 打开 Obsidian 笔记软件。
   • 进入“社区插件”选项卡。
   • 搜索“Note From Template”插件。
   • 点击“安装”按钮，等待安装完成。

2. 启用插件:

   • 安装完成后，点击“启用”按钮，启用插件。

3. 配置模板文件夹:

   • 在 Obsidian 设置中，找到“Note From Template”插件的设置选项。
   • 指定一个文件夹作为模板文件夹，所有模板文件将存放在该文件夹中。

4. 创建模板文件:

   • 在指定的模板文件夹中，创建一个新的 Markdown 文件，作为模板文件。
   • 在模板文件中，使用 YAML 前置元数据定义模板的行为和属性。例如：

     ---
     template-output: People
     tags: person, [[tags]]
     template-replacement: "[[[[title]]]] 	[[[[title]]#^overview]]"
     template-input: title, overview, body
     template-should-replace: "sometimes"
     template-should-create: "open-pane"
     ---
     # [[title]]
     [[overview:area]] ^overview
     Organisation: [[organisation]]
     [[body]]
     

5. 使用模板创建笔记:

   • 在 Obsidian 中，打开命令面板（快捷键 Ctrl+P）。
   • 输入“From Template”命令，选择你创建的模板。
   • 根据提示输入所需的字段值，插件将根据模板生成新的笔记。

注意事项

• 确保模板文件夹路径正确，否则插件可能无法找到模板文件。
• 在模板文件中，使用 Mustache 语法定义变量，例如 [[title]]。
• 插件支持多种字段类型，如文本、日期、选择等，可以根据需要进行配置。

通过以上步骤，你就可以成功安装并配置 Obsidian Note From Template 插件，并使用它快速创建笔记。

obsidian-note-from-template Simple plugin to create Notes from a template, and fill in fields defined there 项目地址: https://gitcode.com/gh_mirrors/ob/obsidian-note-from-template