Skip to content

Latest commit

 

History

History
109 lines (75 loc) · 3.96 KB

README.md

File metadata and controls

109 lines (75 loc) · 3.96 KB
Raw

Smart Templates for Obsidian

Smart Templates allows you to create and use configurable templates utilizing Smart Environments.

Smart Templates is a companion plugin to Smart Connections, a plugin for Obsidian that implements a Smart Environment for utilizing AI to enhance your notes.

Features

Create and use customizable templates with dynamic variables.

  • AI-Powered: Leverage AI models to generate content based on your templates, variable prompts, and current context (note or highlighted text).
  • Variable Prompts: Define prompts for each variable for more control over content generation.
  • Flexible Configuration: Choose your preferred AI model platform.
  • Manual Prompt Input: Use {{ "Your prompt here" }} syntax for on-the-fly custom prompts within templates.
  • EJS Syntax Support: Utilize EJS syntax for more advanced template logic and formatting.

More features coming soon...:

Installation

Currently in beta. Requires installing manually or via BRAT.

Smart Connections Supporters: install using the "Easy Install" button in the early-release (version 2.2) plugin settings.

Usage

  1. Set up your preferred AI model platform in the plugin settings.
  2. Create smart templates in the designated templates folder.
  3. Use the command palette to run your smart templates on your notes or selections.

Using Templates

  • A command is created for each template in the templates folder.
  • The command is run on the current note or highlighted selection (if any).
  • The template is rendered and the resulting content is inserted at the current cursor location.

Creating Templates

  1. Navigate to your designated templates folder.
  2. Create a new Markdown file for your template.
  3. Use special syntax to define dynamic parts of your template:
    • {{ variable_name }}: Simple bracket syntax for predefined variables
    • {{ "Your custom prompt here" }}: Manual prompt input syntax
    • <%- ... %>: EJS syntax for advanced logic and formatting

Example template:

# Default Smart Template

### Summary
{{ summary }} <- Simple bracket syntax

### Notes
{{ notes }}

### Chart
<%- '```mermaid' %> <- EJS syntax is also available
{{ mermaid }}
<%- '```' %>

Custom Prompt

{{ "Your custom prompt here" }} <- Manual prompt input syntax

Settings

Model Platform

Choose your preferred AI model platform (e.g., OpenAI) and enter your API key in the settings.

Templates Folder

Specify the folder where your smart templates will be stored.

Variable Prompts

Customize the prompts for template variables like summary, notes, and mermaid charts.

How it Works

graph TD
  A[Smart Template] -->|Contains| B(Variable Placeholders)
  C[var_prompts] -->|Defines| D(Variable Prompts)
  E[Current Context] -->|Provides| F(Content for Processing)
  B --> G{Smart Templates Plugin}
  D --> G
  F --> G
  G -->|Processes| H(AI Model)
  H -->|Generates| I(Variable Content)
  I --> J{Template Rendering}
  A --> J
  J -->|Produces| K[Final Output]
Loading

About

Created by 🌴 Brian as a companion plugin to Smart Connections, a plugin for Obsidian that implements a Smart Environment for utilizing AI to enhance your notes.

Development

Uses JSBrains to minimize dependencies and provide an easily adaptable architecture that supports new models and platforms.