Neovim

Installation & Setup

Install the IWE Plugin

The IWE Neovim plugin is available at: iwe.nvim

Option 1: Using lazy.nvim (recommended)

{
  "iwe-org/iwe.nvim",
  dependencies = {
    "nvim-lua/plenary.nvim", "nvim-telescope/telescope.nvim",
  },
  config = function()
    require("iwe").setup()
  end,
}

Option 2: Using packer.nvim

use {
  "iwe-org/iwe.nvim",
  requires = {
    "nvim-lua/plenary.nvim",
    "nvim-telescope/telescope.nvim",
  },
  config = function()
    require("iwe").setup()
  end,
}

Option 3: Using vim-plug

Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-telescope/telescope.nvim'
Plug 'iwe-org/iwe.nvim'

" Add to your init.vim after plug#end()
lua require("iwe").setup()

Option 4: Manual Installation

git clone https://github.com/iwe-org/iwe.nvim.git ~/.local/share/nvim/site/pack/plugins/start/iwe.nvim

Prerequisites

The IWE plugin requires the iwes LSP server binary to be installed on your system:

Install via Cargo (recommended):
```
cargo install iwe
```
Download from GitHub Releases:
- Visit IWE releases
- Download the appropriate binary for your system
- Ensure iwes is in your system PATH

Build from Source:

git clone https://github.com/iwe-org/iwe.git
cd iwe
cargo build --release --bin iwes
# Copy target/release/iwes to your PATH

Verify Installation

Open Neovim in a directory with markdown files
Open a .md file
Run :checkhealth iwe to verify the plugin is working
Check :LspInfo to see if the IWE LSP server is attached

Neovim Shortcuts for IWE Actions

Default Keybindings

The plugin provides these default keybindings (can be customized):

IWE Feature Keybindings

IWE Feature	Neovim Shortcut	Mode	Description
Code Actions	ca	Normal	Extract/Inline/Transform code actions
Go to Definition	gd	Normal	Go to definition of symbol under cursor
Find References	gr	Normal	Find backlinks to current document
Document Symbols	ds	Normal	Navigate document outline
Workspace Search	ws	Normal	Global search with Telescope
Format Document	f	Normal/Visual	Auto-format document
Rename Symbol	rn	Normal	Rename symbol (including file & references)

LSP Keybindings

Feature	Shortcut	Description
Hover Info	K	Show information about current element
Signature Help		Show function signature (Insert mode)
Code Action	ca	Show available code actions
Diagnostic Next	]d	Jump to next diagnostic
Diagnostic Previous	[d	Jump to previous diagnostic

Telescope Integration

Command	Shortcut	Description
:Telescope iwe search	ws	Search through all notes
:Telescope iwe backlinks	wb	Find backlinks to current document
:Telescope iwe links	wl	Browse all links in current document

Configuration

Basic Setup

require("iwe").setup({
  -- LSP server configuration
  lsp = {
    -- Path to iwes binary (auto-detected if in PATH)
    cmd = { "iwes" },
    
    -- LSP server settings
    settings = {
      iwe = {
        debug = false,
      },
    },
  },
  
  -- Keybindings (set to false to disable default bindings)
  keybindings = {
    enable = true,
    
    -- Custom keybindings
    code_action = "<leader>ca",
    goto_definition = "gd",
    find_references = "gr",
    document_symbols = "<leader>ds",
    workspace_search = "<leader>ws",
    format_document = "<leader>f",
    rename_symbol = "<leader>rn",
  },
  
  -- Telescope integration
  telescope = {
    enable = true,
    
    -- Telescope-specific settings
    search = {
      layout_strategy = "horizontal",
      layout_config = {
        preview_width = 0.6,
      },
    },
  },
})

Advanced Configuration

require("iwe").setup({
  -- LSP configuration
  lsp = {
    cmd = { "iwes" },
    filetypes = { "markdown" },
    root_dir = function(fname)
      return require("lspconfig.util").root_pattern(".iwe")(fname)
        or require("lspconfig.util").find_git_ancestor(fname)
        or vim.loop.os_homedir()
    end,
    
    -- Custom capabilities
    capabilities = require("cmp_nvim_lsp").default_capabilities(),
    
    -- LSP server settings
    settings = {
      iwe = {
        debug = vim.env.IWE_DEBUG == "true",
        trace = "off", -- or "messages", "verbose"
      },
    },
    
    -- Custom handlers
    handlers = {
      ["textDocument/hover"] = vim.lsp.with(vim.lsp.handlers.hover, {
        border = "rounded",
      }),
    },
  },
  
  -- Disable default keybindings and set custom ones
  keybindings = {
    enable = false, -- Disable defaults
  },
  
  -- Telescope customization
  telescope = {
    enable = true,
    extensions = {
      iwe = {
        search = {
          prompt_title = "IWE Search",
          results_title = "Documents",
        },
        backlinks = {
          prompt_title = "Backlinks",
          results_title = "References",
        },
      },
    },
  },
  
  -- Health check configuration
  health = {
    check_iwes_binary = true,
    check_iwe_config = true,
  },
})

-- Custom keybindings
local map = vim.keymap.set
map("n", "<leader>ia", "<cmd>lua vim.lsp.buf.code_action()<cr>", { desc = "IWE Code Actions" })
map("n", "<leader>ig", "<cmd>lua vim.lsp.buf.definition()<cr>", { desc = "IWE Go to Definition" })
map("n", "<leader>ir", "<cmd>lua vim.lsp.buf.references()<cr>", { desc = "IWE Find References" })
map("n", "<leader>is", "<cmd>Telescope iwe search<cr>", { desc = "IWE Search" })
map("n", "<leader>ib", "<cmd>Telescope iwe backlinks<cr>", { desc = "IWE Backlinks" })
map("n", "<leader>if", "<cmd>lua vim.lsp.buf.format()<cr>", { desc = "IWE Format" })
map("n", "<leader>in", "<cmd>lua vim.lsp.buf.rename()<cr>", { desc = "IWE Rename" })

Which-Key Integration

If you use which-key.nvim, add descriptions for IWE commands:

require("which-key").register({
  ["<leader>i"] = {
    name = "IWE",
    a = "Code Actions",
    g = "Go to Definition",
    r = "Find References", 
    s = "Search",
    b = "Backlinks",
    f = "Format Document",
    n = "Rename",
  },
})

Usage Examples

Extracting a Section

Place cursor on a header line (e.g., ## Section Title)
Press <leader>ca to open code actions
Select “Extract section” from the list
Neovim will create a new buffer with the extracted content

Following Links

Place cursor on any markdown link
Press gd to follow the link
Use <C-o> to return to the previous location

Finding Backlinks

In any document, press gr or <leader>wb
Telescope will show all documents linking to the current one
Use arrow keys to navigate, Enter to open

Global Search with Telescope

Press <leader>ws to open IWE search
Start typing to search across all documents
Results show document paths and matching content
Use <C-p> preview to see content without opening

Text Transform Actions (if configured)

Select text in visual mode
Press <leader>ca to show code actions
Choose from available transform actions
The text will be processed and replaced

Telescope Commands

Available Commands

" Search through all notes
:Telescope iwe search

" Find backlinks to current document  
:Telescope iwe backlinks

" Browse links in current document
:Telescope iwe links

" Show document symbols/outline
:Telescope lsp_document_symbols

" Search workspace symbols
:Telescope lsp_workspace_symbols

Key	Action
	Open selected item
	Open in horizontal split
	Open in vertical split
	Open in new tab
	Scroll preview up
	Scroll preview down
	Send to quickfix list

Health Check

Run health checks to verify your setup:

:checkhealth iwe

This will check:

IWE plugin installation
iwes binary availability
LSP server configuration
Telescope integration
IWE project configuration

Troubleshooting

Common Issues

LSP Server Not Starting

# Check if iwes is in PATH
which iwes

# Check LSP server status
:LspInfo

# View LSP logs
:LspLog

Telescope Not Working

-- Ensure telescope is loaded
require("telescope").load_extension("iwe")

Keybindings Not Working
- Check if default keybindings are enabled in config
- Verify no conflicts with other plugins
- Use :verbose map <key> to check key mappings
Performance Issues
- Check :IweStatus for server information
- Consider workspace size and complexity
- Enable debug mode temporarily: IWE_DEBUG=true nvim

Debug Mode

Enable debug logging:

# Start Neovim with debug mode
IWE_DEBUG=true nvim

# Or set in Neovim
:lua vim.env.IWE_DEBUG = "true"
:LspRestart

Debug logs will be written to iwe.log in your working directory.

Getting Help

Plugin Repository: iwe.nvim Issues
Main Project: IWE Issues
Discussions: Community Support
Documentation: Full Wiki

Integration with Other Plugins

nvim-cmp (Autocompletion)

require("cmp").setup({
  sources = {
    { name = "nvim_lsp" }, -- Includes IWE completions
    { name = "buffer" },
    { name = "path" },
  },
})

nvim-treesitter

require("nvim-treesitter.configs").setup({
  ensure_installed = { "markdown", "markdown_inline" },
  highlight = { enable = true },
})

gitsigns.nvim

IWE works well with git integration for version control of your knowledge base.

Best Practices for Neovim

Use Workspace Sessions: Save and restore IWE workspace sessions
Configure LSP Properly: Ensure proper root directory detection
Leverage Telescope: Use fuzzy finding for efficient navigation
Set Up Health Checks: Regular :checkhealth iwe for maintenance
Customize Keybindings: Adapt shortcuts to your workflow
Use Splits and Tabs: Work with multiple documents simultaneously
Enable Auto-Save: Use :set autowrite to prevent data loss
Integrate with Git: Version control your knowledge base
Configure Completion: Set up nvim-cmp for link auto-completion
Use Which-Key: Document your IWE keybindings for easy reference

VS Code Helix