jubnzv/mdeval.nvim

github github
markdown plugin
star 31
stars
alert-circle 0
open issues
users 4
subscribers
git-branch 2
forks
CREATED

2021-06-13

UPDATED

23 days ago

packer

require('packer').startup(function()
  use 'jubnzv/mdeval.nvim'
end)

paq

require "paq" { 
  'jubnzv/mdeval.nvim'
}

mdeval.nvim

This plugin allows you evaluate code blocks inside markdown, vimwiki, orgmode.nvim and norg documents.

It attempts to implement the basic functionality of org-mode's evaluating code blocks feature inside Neovim.

Demo

Requirements

This plugin requires Neovim version 0.5+.

It works on Linux, MacOS and Windows (through WSL).

MacOS users should make sure that they have coreutils package installed:

brew install coreutils

Windows users should have installed WSL with compilers/interpreters they want use.

Installation

Install it with your plugin manager.

Then add the following line in your init.lua:

require 'mdeval'.setup()

You should also enable syntax highlighting inside code blocks for your languages using the built-in functionality:

vim.g.markdown_fenced_languages = {'python', 'cpp'}

Usage

To use this plugin, you should move cursor inside a fenced code block with language identifier and execute the :MdEval command. mdeval.nvim will capture the results of the code block execution and inserts them in the markdown file, right after the code block.

Configuration

You can configure mdeval.nvim by running the mdeval.setup function.

Here is an example:

require 'mdeval'.setup({
  -- Don't ask before executing code blocks
  require_confirmation=false,
  -- Change code blocks evaluation options.
  eval_options = {
    -- Set custom configuration for C++
    cpp = {
      command = {"clang++", "-std=c++20", "-O0"},
      default_header = [[
    #include <iostream>
    #include <vector>
    using namespace std;
      ]]
    },
    -- Add new configuration for Racket
    racket = {
      command = {"racket"},        -- Command to run interpreter
      language_code = "racket",    -- Markdown language code
      exec_type = "interpreted",   -- compiled or interpreted
      extension = "rkt",           -- File extension for temporary files
    },
  },
})

By default, the plugin will ask your confirmation before evaluating code. This makes sense, because code evaluation is potentially harm operation. You can disable this feature setting require_confirmation option to false, or allow to execute code blocks without confirmation only for some languages, using allowed_file_types option, for example: allowed_file_types={'rust', 'haskell'}.

Probably, it will be a good idea to define keybindings to call :MdEval. This plugin doesn't add default keybindings, but you can do this in your configuration file, for example:

vim.api.nvim_set_keymap('n', '<leader>c',
                        "<cmd>lua require 'mdeval'.eval_code_block()<CR>",
                        {silent = true, noremap = true})

See the complete list of options in the documentation.

See also

  • Sniprun – A similar plugin written in Rust with much more features.