telekasten, take over my home!

README.md

@@ -185,6 +185,10 @@ lua << END
 local home = vim.fn.expand("~/zettelkasten")
 require('telekasten').setup({
     home         = home,
+
+    -- if true, telekasten will be enabled when opening a note within the configured home
+    take_over_my_home = true,
+
     dailies      = home .. '/' .. 'daily',
     weeklies     = home .. '/' .. 'weekly',
     templates    = home .. '/' .. 'templates',
@@ -249,6 +253,7 @@ END
 | setting | description | example |
 | --- | --- | --- |
 | `home` | path to your zettelkasten folder (folder with markdown files) | ~/zettelkasten |
+| **`take_over_my_home`** | if set to `true` (default), telekasten will take over your home. Any notes from the configured `home` directory will receive a `set filetype=telekasten`, no matter if opened by telekasten or another way. | true |
 | `dailies` | path where your daily notes go | ~/zettelkasten/daily |
 | `weeklies` | path where your weekly notes go | ~/zettelkasten/weekly |
 | `templates` | path where your note templates go | ~/zettelkasten/templates |

doc/telekasten.txt

@@ -127,6 +127,15 @@ telekasten.setup({opts})
 
         Default: '~/zettelkasten'
 
+                                   *telekasten.settings.take_over_my_home*
+    take_over_my_home: ~
+        If set to `true`, telekasten.nvim will take over your home. Any notes
+        from the configured `home` directory will receive a `set`
+        `filetype=telekasten`, no matter if opened by telekasten or another
+        way. 
+
+        Default: `true`
+
                                                *telekasten.settings.daily*
     daily: ~
         Path to your daily notes, to separate them from 'normal' notes.

lua/telekasten.lua

@@ -25,6 +25,10 @@ local M = {}
 
 M.Cfg = {
     home = home,
+
+    -- if true, telekasten will be enabled when opening a note within the configured home
+    take_over_my_home = true,
+
     dailies = home .. "/" .. "daily",
     weeklies = home .. "/" .. "weekly",
     templates = home .. "/" .. "templates",
@@ -1591,6 +1595,10 @@ local function Setup(cfg)
     -- setting the syntax moved into plugin/telekasten.vim
     -- and does not work
 
+    if M.Cfg.take_over_my_home == true then
+        vim.cmd('au BufEnter ' .. M.Cfg.home .. '/*' .. M.Cfg.extension .. ' set ft=telekasten')
+    end
+
     if debug then
         print("Resulting config:")
         print("-----------------")