Templater插件使用手册

Templater插件使用手册

Templater A template plugin for obsidian 项目地址: https://gitcode.com/gh_mirrors/te/Templater

---

安装指南

要安装Templater插件到您的Obsidian环境，请遵循以下步骤：

1. 确保Obsidian版本兼容：确认您的Obsidian版本支持社区插件安装。
2. 访问插件市场：在Obsidian中，打开设置（通常通过侧边栏底部的齿轮图标），然后进入“社区插件”选项。
3. 搜索插件：在搜索框中输入“Templater”，找到由SilentVoid13维护的插件。
4. 安装插件：点击插件旁边的相关按钮进行安装。安装完成后，需要重新启动Obsidian使插件生效。

若手动安装，可以从GitHub仓库下载最新版本的插件文件，并按照Obsidian的本地插件安装指引操作。

---

使用说明

基本用法

• 插入变量与函数：利用Templater的语言特性，在笔记中插入动态内容，如日期、文件路径或其他自定义变量。
• 执行JavaScript代码：撰写JS片段来处理和生成复杂的笔记内容。
• 模板示例：实践是最好的老师。查看官方讨论区的【模板展示】类别，获取灵感与实际案例。

示例

假设您想在每天的日记中自动添加当前日期，您可以创建一个包含tp:date命令的模板。

今天是 {{tp:date "%Y-%m-%d"}}。

---

API使用文档

Templater提供了一系列内置的函数，如tp:date用于日期格式化，tp:file用于文件操作等。详细的功能列表和使用方法，请参考官方文档页面：SilentVoid13的Templater文档。对于每个函数，了解其参数和返回值是编写高效模板的关键。

内部函数概览

• tp:date - 生成格式化的日期字符串。
• tp:file - 读写文件操作。
• tp:frontmatter - 处理Markdown前缀元数据。
• ...以及其他更多高级和内部函数，具体请参照完整文档。

---

项目安装方式

前面已经概述了用户级的安装步骤，对于开发者想要从源码构建或贡献到项目，则需：

1. 克隆仓库：使用Git克隆Templater的GitHub仓库到本地。
2. 环境准备：确保Node.js和npm安装好，以便进行依赖管理和构建。
3. 安装依赖：在项目根目录下运行npm install。
4. 开发模式运行：可以通过特定命令（通常在项目的README或文档中说明）启动开发服务器，测试您的修改。

---

请注意安全提示，仅从可信来源运行脚本，并利用此手册深入探索和利用Templater的强大功能，为您的Obsidian笔记增添无限可能。如果您在使用过程中遇到难题，不妨参与到社区讨论中，分享经验和寻求帮助。

Templater A template plugin for obsidian 项目地址: https://gitcode.com/gh_mirrors/te/Templater