Notes from Template 插件技术文档

Notes 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

首先，确保你已经安装了 Obsidian 笔记应用。如果你还没有安装，可以从官方网站下载并安装。

2. 安装插件

1. 打开 Obsidian，进入“设置”（Settings）。
2. 在左侧菜单中选择“社区插件”（Community Plugins）。
3. 点击“浏览”（Browse）按钮，搜索“Notes from Template”插件。
4. 找到插件后，点击“安装”（Install）按钮。
5. 安装完成后，点击“启用”（Enable）按钮。

3. 配置插件

1. 安装并启用插件后，进入“设置”（Settings）。
2. 在左侧菜单中选择“Notes from Template”插件。
3. 配置插件的模板目录（templates directory）和其他相关设置。

项目的使用说明

1. 创建模板文件

在插件的模板目录中创建一个新的 Markdown 文件，文件内容如下：

---
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}}

2. 使用模板创建笔记

1. 在 Obsidian 中打开一个笔记。
2. 选择你想要替换的文本（可选）。
3. 在命令面板中输入“From Template: <模板名称>”并选择相应的模板。
4. 弹出窗口将请求输入模板中定义的变量值。
5. 输入完成后，点击“提交”（Mod + Enter）。

3. 查看生成的笔记

插件将根据模板生成一个新的笔记，并根据配置决定是否在新窗口中打开。

项目API使用文档

1. 模板变量

模板中可以使用以下变量：

• {{title}}：笔记标题
• {{overview}}：概述内容
• {{body}}：主体内容
• {{organisation}}：组织名称
• {{tags}}：标签

2. 模板属性

模板文件的 YAML 部分可以包含以下属性：

• template-output：输出目录
• tags：标签
• template-replacement：替换文本
• template-input：输入字段
• template-should-replace：是否替换文本
• template-should-create：是否创建新笔记

3. 字段类型

模板中支持以下字段类型：

• text：文本输入
• area：文本区域
• currentDate：当前日期
• choice：下拉选择
• multi：多选

项目安装方式

1. 通过 Obsidian 社区插件安装

如前所述，通过 Obsidian 的社区插件市场安装。

2. 手动安装

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

通过以上步骤，你可以顺利安装并使用 Notes 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