Projects

MDKasten.Nvim Documentation

A NeoVim plugin for easy navigation and linking between Markdown notes.

Installation

This plugin requires ripgrep to work!

Using lazy.vim

{"zenarvus/mdkasten.nvim",
    config = function ()
        require("mdkasten").setup({
            -- Required: Set The Vault Path
            mdkastenPath="~/notes",
            fileTemplate = {
                "# {{title}}",
                "",
                "{{parentNode}}"
            }
        })
        -- Optional: Set Keymaps
        vim.keymap.set('n', 'gf', ":MDKCustomGF<CR>")
        vim.keymap.set('n', 'gh', ":MDKNodeFind<CR>")
        vim.keymap.set('n', 'gH', ":MDKNodeInsert<CR>")
        vim.keymap.set('n', 'gb', ":MDKNodeCreate<CR>")
        -- To use with mandos
        vim.keymap.ser('n', 'gl', ":MDKOpenMDInBrowser")
    end
},

Commands

It is recommended to use only the provided functions to create and delete nodes or to update the titles.
Otherwise, the navigation commands may malfunction.

File Operations

Create Node

Use the :MDKNodeCreate command to create a node and insert its link to the current buffer. The created node will be a child of the current buffer.

The initial content of the new node is determined by the fileTemplate configuration. {{title}} is replaced with the title and {{parentNode}} is replaced with the node link that the new node is created in.

Delete The Current Node

To delete the current node, use the :MDKCurrentNodeDelete command. When it asks you a yes and no question, press "y" and enter.

Update Title of The Node

Use the :MDKNodeTitleUpdate command to change the node title, and update it on all other nodes.

Navigation

Telescope

The :MDKNodeFind command lists all the nodes, and navigates to the selected node.

The :MDKNodeInsert command lists all the files inside the vault, and inserts the selected one to the current buffer.

Custom GF Function

The :MDKCustomGF command navigates to the file on the cursor, or in the current line if its in the markdown format. Otherwise, it uses the xdg-open command to open it.

Preview In Browser

The :MDKOpenMDInBrowser command opens the current markdown file in browser to preview it with mandos

File List Generation

List Orphan Files

The :MDKListOrphans command identifies and lists all the files that do not have links in any other nodes.

If the <!--orphan:s--> and <!--orphan:e--> comments are missing from the current buffer, the list generation will not work.

List Nodes Linking to Non-Existent Files

The :MDKListLTNE command lists the nodes to the current buffer that contain links to non-existent files.

If the <!--ltne:s--> and <!--ltne:e--> comments are not found in the current buffer, the list generation will not work.