https://github.com/gpanders/vim-medieval

Evaluate Markdown code blocks within Vim
https://github.com/gpanders/vim-medieval

literate-programming markdown vim

Last synced: about 2 months ago
JSON representation

Evaluate Markdown code blocks within Vim

• Host: GitHub
• URL: https://github.com/gpanders/vim-medieval
• Owner: gpanders
• License: mit
• Created: 2020-03-03T04:25:37.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T15:31:12.000Z (4 months ago)
• Last Synced: 2024-05-22T16:45:41.857Z (4 months ago)
• Topics: literate-programming, markdown, vim
• Language: Vim Script
• Homepage:
• Size: 43 KB
• Stars: 108
• Watchers: 5
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-list - vim-medieval

README

        
# vim-medieval

Evaluate Markdown code blocks within Vim.

[![asciicast](https://asciinema.org/a/306995.svg)](https://asciinema.org/a/306995)

## Description

Medieval allows you to evaluate code blocks in Markdown buffers of the

following form:

````markdown

```bash

echo "Hello world!"

```

````

By placing your cursor anywhere in the code block above and running

`:EvalBlock`, Medieval will print the result of evaluating the block (in this

case, it will echo "Hello world!")

You can send the output of evaluation into another code block, allowing

you to do a primitive style of literate programming. You can accomplish this

by adding a "target" parameter to your code block and creating a second code

block with a "name" parameter. The output of the evaluation of your code block

will be redirected to the targeted block. For example:

````markdown

```python

print([x*x for x in range(5)])

```

```

```

````

If you run `:EvalBlock` in the first code block, the second block will become

````markdown

```

[0, 1, 4, 9, 16]

```

````

Medieval can do a lot more. Read `:h medieval` for the full documentation.

## Create a mapping

Medieval does not create any mappings by default, but you can easily create one

yourself by adding the following to the file

`~/.vim/after/ftplugin/markdown.vim` (create it if it does not yet exist):

```vim

nmap  Z! (medieval-eval)

```

## Limitations

For now, Medieval only works in Markdown buffers. If you'd like to see support

added for other file types, please see the [Contributing](#contributing)

section.

## Contributing

Please feel free to contribute changes or bug fixes. You can [send patches][]

to  or submit a pull request on [GitHub][].

[send patches]: https://git-send-email.io/

[Github]: https://github.com/gpanders/vim-medieval