File Based Prompts - ckt1031/obsidian-wordwise-plugin GitHub Wiki

Custom Prompts Using Local Markdown Files

This guide will walk you through creating your own custom prompts using local Markdown files.

Setting Up Your Template Folder

First, you need to tell the plugin where to find your prompt templates.

  1. Enable File Prompts: Go to the plugin settings and turn on the "File Prompts" option.
  2. Set Your Folder Path: In the "Folder Path" field, enter the relative path to your templates folder. For example, if your folder is named Prompts and it's inside a folder called Collections, you would enter Collections/Prompts.

Adding a New Prompt

Now you can start creating your own prompts.

  1. Create a New Note: In the template folder you just set up, create a new note.
  2. Add Properties: At the very top of the new note, type --- to create a properties section. Add a name field and give your prompt a descriptive name.
  3. Write Your Instructions: Below the properties, type the instructions for your prompt. You don't need to add extra instructions like "don't add any other context" or "edit the text directly," as the plugin already handles this.

Example:

---
name: Make Text More Professional
---

Help me to make this text more professional, polite, and formal.

The plugin will automatically detect and update any new prompts or changes you make.

Advanced Options (Extra Fields)

You can add more properties to your prompts for further customization.

---
name: # Required: The name of your prompt.

# --- Optional Properties ---
disabled: # Set to "true" to hide this prompt from the list.
model: # Specify a particular AI model to use (e.g., gpt-4.1).
provider: # Specify the AI provider (e.g., OpenAI).
systemPrompt: # Replace the default system instructions with your own.

# Below are only available for version after v1.3.0
icon: # Add a custom icon to your prompt.
omitOriginal: # true or false (Default: false) Enable to make LLM not responding the original text when you are not going to rewrite the text and extend it.
behavior: # Options: insert-first, insert-last, replace
---

Behavior

  • replace (Default) Replace the original text with LLM response.
  • insert-first Insert the text before the original.
  • insert-last Insert the text AFTER the original.

Customizing Icons

You can assign a unique icon to each prompt in two ways:

  • Using Lucide Icons:

    1. Visit lucide.dev/icons.
    2. Find an icon you like and copy its name (ID).
    3. Paste the ID into the icon field.

    Example with book-plus icon:

  • Using a Custom Character:

    • If you enter any text that isn't a Lucide icon ID, the plugin will use the first character as the icon. This can be a letter, number, or even an emoji.

    Example with a character icon: