Settings

Template folder location

Files in this folder will be available as templates.

In Templater - data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "templates_folder": ""

Warning

Be careful when using Esc to close out the Settings menu, as it could actually clear the set template folder location instead.

Internal variables and functions

Templater provides multiples predefined variables / functions that you can use. Check the documentation to get a list of all the available internal variables / functions.

Syntax highlighting on desktop

Adds syntax highlighting for Templater commands in edit mode.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "syntax_highlighting": true

Syntax highlighting on mobile

Adds syntax highlighting for Templater commands in edit mode on mobile. Use with caution: this may break live preview on mobile platforms.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "syntax_highlighting_mobile": false

Automatic jump to cursor

Automatically trigger tp.file.cursor after inserting a template. You can also set a hotkey to manually trigger tp.file.cursor.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "auto_jump_to_cursor": false

Trigger Templater on new file creation

Templater will listen for the new file creation event, and, if it matches a rule you’ve set, replace every command it finds in the new file’s content. This makes Templater compatible with other plugins like the Daily note core plugin, Calendar plugin, Review plugin, Note refactor plugin, etc.

Make sure to set up rules under either folder templates or file regex template below.

Warning: This can be dangerous if you create new files with unknown / unsafe content on creation. Make sure that every new file’s content is safe on creation.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "trigger_on_file_creation": false

Folder templates

Warning

The settings in this section only appear if Trigger Templater on new file creation is set to true.

Folder templates are triggered when a new empty file is created in a given folder. Templater will fill the empty file with the specified template. The deepest match is used. A global default template would be defined on the root /.

Enable folder templates

When enabled, Templater will make use of the folder templates defined below. This option is mutually exclusive with file regex templates below, so enabling one will disable the other.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "enable_folder_templates": true,
  "folder_templates": [
    {
      "folder": "",
      "template": ""
    }
  ]

File regex templates

Warning

The settings in this section only appear if Trigger Templater on new file creation is set to true.

File regex templates are triggered when a new empty file is created that matches one of them. Templater will fill the empty file with the specified template. The first match from the top is used, so the order of the rules is important. Use .* as a final catch-all, if you need it.

Enable file regex templates

When enabled, Templater will make of the file regex templates defined below. This option is mutually exclusive with folder templates above, so enabling one will disable the other.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "enable_file_templates": false,
  "file_templates": [
    {
      "regex": ".*",
      "template": ""
    }
  ]

Template hotkeys

Template hotkeys allows you to bind a template to a hotkey.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "enabled_templates_hotkeys": [
    ""
  ]

Startup templates

Startup templates are templates that will get executed once when Templater starts. These templates won’t output anything. This can be useful to set up templates adding hooks to Obsidian events for example.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "startup_templates": []

User script functions

Script files folder location

All JavaScript files in this folder will be loaded as CommonJS modules, to import custom user functions. The folder needs to be accessible from the vault. Check the documentation for more information.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "user_scripts_folder": ""

User script intellisense

Determine how you’d like to have user script intellisense render. Note values will not render if not in the script.

• Turn off intellisense (0)
• Render method description, parameters list, and return (1)
• Render method description and parameters list (2)
• Render method description and return (3)
• Render method description (4)

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "intellisense_render": 1

User system command functions

Enable user system command functions

Allows you to create user functions linked to system commands. Warning: It can be dangerous to execute arbitrary system commands from untrusted sources. Only run system commands that you understand, from trusted sources.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "enable_system_commands": false

Timeout

Warning

This setting only appear if Enable user system command functions is set to true.

Maximum timeout in seconds for a system command.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "command_timeout": 5

Shell binary location

Warning

This setting only appear if Enable user system command functions is set to true.

Full path to the shell binary to execute the command with. This setting is optional and will default to the system’s default shell if not specified. You can use forward slashes (’/’) as path separators on all platforms if in doubt.

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

Default:

  "shell_path": ""

In data.json

Only written to data.json upon update. If there isn’t a data.json, it will be created.

This property is used to define system command user functions.

Default:

  "template_pairs": []

Donate

If you like this Plugin, consider donating to support continued development.

GitHub Sponsors | Paypal