Note

• Default Note Template
• Note ID Presets
• Options

Default Note Template

The "default default template" when creating notes look like the following for historical and practical reasons:

---
id: {{id}}
aliases:
  - {{title}}
tags: []
---

You can control the style of your default notes created by :Obsidian new with opts.note.template

require("obsidian").setup {
  note = {
    -- template = vim.NIL, -- disables the default note template and just use a blank note
    template = "default.md", -- A template you can define your self
  },
}

For fields you have access to for the default template, see Template.

Note ID Presets

By default obsidian.nvim uses random zettel IDs.

If you want readable UTF-8 title-based IDs (works across scripts), use the built-in preset:

require("obsidian").setup {
  note = {
    id_func = require("obsidian.builtin").title_id,
  },
}

Examples:

• "Hello, world" -> "hello-world"
• "Привет, мир" -> "привет-мир"
• "你好 世界" -> "你好-世界"

When creating notes in a directory where the slug already exists, this preset appends a numeric suffix (-2, -3, ...).

Options

---@class obsidian.config.NoteOpts
---
---Default template to use, relative to template.folder or an absolute path.
---
---@field template string|?
note = {
  template = (function()
    local root = vim.iter(vim.api.nvim_list_runtime_paths()):find(function(path)
      return vim.endswith(path, "obsidian.nvim")
    end)
    if not root then
      return nil
    end
    return vim.fs.joinpath(root, "data/default_template.md")
  end)(),
}