tekken.nvim

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

(★ 16)

No description available.

tekken.nvim Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<div align="center">
  <h1>tekken.nvim</h1>
  <p><strong>Getting you to your marks with the fewest keystrokes.</strong></p>
  <p>
    <img alt="Lua" src="https://img.shields.io/badge/Lua-5.1%2B-2C2D72?logo=lua&logoColor=white">
    <img alt="Neovim" src="https://img.shields.io/badge/Neovim-0.8%2B-57A143?logo=neovim&logoColor=white">
  </p>
  <img src="./assets/tekken-logo.png" alt="tekken.nvim logo" width="320" />
  <p>
    <img src="./assets/prompt-flare.svg" alt="Prompted with heart by Victor Vibe" width="320" />
  </p>
</div>

## Showcase

`tekken.nvim` is a local-mark navigator for Neovim with a two-pane floating UI:
- Left: editable list of marks.
- Right: live preview around the selected mark.

It focuses on marks in the current buffer (`a-z`) and gives you fast cycling and jump actions.

## Requirements

- Neovim `>= 0.8`

## Installation (lazy.nvim)

Use this in your Lazy spec to install from GitHub:

```lua
return {
  {
    "soon2moon/tekken.nvim",
    name = "tekken.nvim",
    cmd = { "TekkenToggle", "TekkenNext", "TekkenPrev", "TekkenSync" },
    keys = {
      { "<leader>m", "<cmd>TekkenToggle<cr>", desc = "Tekken: local marks menu" },
      { "]m", "<cmd>TekkenNext<cr>", desc = "Tekken: next local mark" },
      { "[m", "<cmd>TekkenPrev<cr>", desc = "Tekken: prev local mark" },
    },
    opts = {
      order = "added", -- or "position"
      -- prune_missing = true,
      -- auto_sync = false,      -- set true if you want background syncing
      -- max_width = 140,        -- total combined width (list + gap + preview)
      -- max_height = 14,
      -- list_ratio = 0.40,      -- list width ratio
      -- gap = 2,                -- space between list and preview windows
      -- preview_context = 10,   -- lines above/below the mark
    },
    config = function(_, opts)
      require("tekken").setup(opts)
    end,
  },
}
```

## Usage

1. Set local marks in a buffer (for example `ma`, `mb`, `mc`).
2. Open Tekken with `<leader>m` (recommended) or `:TekkenToggle`.
3. Move through rows with normal Vim motions (`j`, `k`, `<C-n>`, `<C-p>`, etc.).
4. Press `<CR>` to jump to the selected mark (or use split/vsplit/tab actions).
5. Reorder or delete lines in the list pane if needed.
6. Run `:write` in the list pane to apply changes back to marks.

## Commands

| Command | Description |
| --- | --- |
| `:TekkenToggle` | Open/close Tekken UI for current buffer marks |
| `:TekkenNext` | Jump to the next mark in the Tekken list |
| `:TekkenPrev` | Jump to the previous mark in the Tekken list |
| `:TekkenSync` | Re-sync current buffer list from real marks |

## Default UI Keymaps

These keymaps are active inside the Tekken list window.

| Action | Default |
| --- | --- |
| Close | `q`, `<Esc>` |
| Select in current window | `<CR>` |
| Open in horizontal split | `<C-x>` |
| Open in vertical split | `<C-v>` |
| Open in new tab | `<C-t>` |
| Move down | `j`, `<C-n>` |
| Move up | `k`, `<C-p>` |

## Configuration (Lazy opts)

With Lazy.nvim, configure Tekken directly in your plugin `opts` table.

```lua
opts = {
  marks = "abcdefghijklmnopqrstuvwxyz",
  border = "rounded",
  title = " Tekken ",
  title_pos = "center",

max_height = 18,
  max_width = 140,

list_ratio = 0.42,
  gap = 2,
  preview_context = 12,

order = "added", -- or "position"
  prune_missing = true,

-- Present in config; currently not wired to autocmd setup in this version.
  auto_sync = false,
  sync_events = { "BufEnter", "InsertLeave", "CursorHold" },

keymaps = {
    close = { "q", "<Esc>" },
    select = { "<CR>" },
    split = { "<C-x>" },
    vsplit = { "<C-v>" },
    tab = { "<C-t>" },
    down = { "<C-n>" },
    up = { "<C-p>" },
  },
}
```

## Notes

- Tekken reads local marks only by default (`a-z`).
- `order = "added"` preserves insertion order across syncs.
- `order = "position"` always sorts by line/column.

tekken.nvim

tekken.nvim Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

tekken.nvim

tekken.nvim Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README