Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LAzyVim config options to README and sign it #94

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add LAzyVim config options to README and sign it #94

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,33 @@ If you use `vim-plug`,
Plug 'dccsillag/magma-nvim', { 'do': ':UpdateRemotePlugins' }
```

If you use LazyVim,
*note: you will need to adjust the keymappings to suit yourself.*

```lua
return {
{
"dccsillag/magma-nvim",
version = "*",
run = "UpdateRemotePlugins",
keys = {
{ "<leader>mi", "<cmd>MagmaInit<CR>", desc = "This command initializes a runtime for the current buffer." },
{ "<leader>mo", "<cmd>MagmaEvaluateOperator<CR>", desc = "Evaluate the text given by some operator." },
{ "<leader>ml", "<cmd>MagmaEvaluateLine<CR>", desc = "Evaluate the current line." },
{ "<leader>mv", "<cmd>MagmaEvaluateVisual<CR>", desc = "Evaluate the selected text." },
{ "<leader>mc", "<cmd>MagmaEvaluateOperator<CR>", desc = "Reevaluate the currently selected cell." },
{ "<leader>mr", "<cmd>MagmaRestart!<CR>", desc = "Shuts down and restarts the current kernel." },
{
"<leader>mx",
"<cmd>MagmaInterrupt<CR>",
desc = "Interrupts the currently running cell and does nothing if not cell is running.",
},
},
},
}

```

Note that you will still need to configure keymappings -- see [Keybindings](#keybindings).

## Suggested settings
Expand Down