https://github.com/kurama622/markdown-org

Run code in markdown
https://github.com/kurama622/markdown-org

markdown neovim neovim-plugin nvim nvim-plugin

Last synced: 4 days ago
JSON representation

Run code in markdown

• Host: GitHub
• URL: https://github.com/kurama622/markdown-org
• Owner: Kurama622
• Created: 2021-01-31T13:19:02.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-31T04:35:30.000Z (3 months ago)
• Last Synced: 2024-09-03T16:37:36.269Z (2 months ago)
• Topics: markdown, neovim, neovim-plugin, nvim, nvim-plugin
• Language: Vim Script
• Homepage:
• Size: 1.29 MB
• Stars: 10
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Markdown-Org

![vim](https://img.shields.io/badge/vim-neovim-red)

ENGLISH  |  [中文版](./README_cn.md)

## Show

![codeblock](./screenshot/markdown-org-codeblock.gif)

![language](./screenshot/markdown-org-language.gif)

[More screenshots](./screenshot)

## Introduction

1. You can preview the result of every code block in markdown, and the result will be showed in floating window. It does not discrupt your current window layout.

2. If there are mulitple languages in your markdown, you can choose to run one of them. It will select all code blocks using the language, and run them in the order which they appear in the text. Finally, the result will be showed in floating window.

## Install

If you use `lazy.nvim`, you can install by following commands:

```lua

{

  "Kurama622/markdown-org",

  ft = "markdown",

  config = function()

    return {

      default_quick_keys = 0,

      vim.api.nvim_set_var("org#style#border", 2),

      vim.api.nvim_set_var("org#style#bordercolor", "FloatBorder"),

      vim.api.nvim_set_var("org#style#color", "String"),

      language_path = {

        python = "python",

        python3 = "python3",

        go = "go",

        c = "gcc",

        cpp = "g++",

      },

    }

  end,

  keys = {

    { "mr", "call org#main#runCodeBlock()" },

    { "ml", "call org#main#runLanguage()" },

  },

},

```

If you use `vim-plug`, you can install by following commands:

```vim

Plug 'Kurama622/markdown-org', {'for':'markdown'}

```

If you use `dein`, you can install by following commands:

```vim

[[plugins]]

repo = 'Kurama622/markdown-org'

on_ft = 'markdown'

```

## Settings

If you set `let g:default_quick_keys=1` in your `.vimrc` or `init.vim`, you will use default settings.

```vim

let g:default_quick_keys = 1

```

### Default Quick Keys and Parameters

| Parameters / Quick keys   | Function                                                                    |

|---------------------------|-----------------------------------------------------------------------------|

| `Alt+b`                   | Expand the result of current code block                                     |

| `Alt+l`                   | Run all code blocks of a language, and it will popup select box of language |

| `g:language_path`         | Set evnironmental path of languages                                         |

| `g:org#style#border`      | Set the style of border (0, 1, 2, 3, 4, 5), 0: no border                    |

| `g:org#style#bordercolor` | Set the color of border                                                     |

| `g:org#style#color`       | Set the color of result text                                                |

### Border Style

| Border number |                                     Show                                     |

|:-------------:|:----------------------------------------------------------------------------:|

|    border0    |  |

|    border1    |  |

|    border2    |  |

|    border3    |  |

|    border4    |  |

|    border5    |  |

### Custom Parameters and Quick Keys Settings

If you wish custom parameters and quick keys, you can refer the example:

```vim

let g:default_quick_keys = 0

let g:org#style#border = 2

let g:org#style#bordercolor = 'keyword'

let g:org#style#color = 'Identifier'

let g:language_path = {

            \ "python":"python",

            \ "python3":"python3",

            \ "go": "go",

            \ "c": "gcc",

            \ "cpp": "g++",

            \ "c++": "g++",

            \ "javascript": "node",

            \ }

nnoremap   :call org#main#runCodeBlock()

nnoremap   :call org#main#runLanguage()

```

1. You need set `let g:default_quick_keys=0`, it will disable default settings.

2. `g:org#style#border` can be set to 0 - 5.

3. `g:org#style#bordercolor` and `g:org#style#color` can be set different colors. You can choose a color from `keyword`, `Identifier`, `Statement`, `Comment`, `PreProc`, `Ignore`, `Label`, `Conditional`, `Exception`, etc. The final effect will depend on your current theme.

4. `g:language_path` can be used to set different languages' evnironmental path. If your evnironment of the language is ok, default setting will work well. If your evnironment exists some problems, for example, when you input python, you can not enter interactive mode. In this case, you can write your python path into `g:language_path`:

```vim

let g:language_path = {

            \ "python":"/usr/bin/python",

            \ "python3":"python3",

            \ "go": "go",

            \ "c": "gcc",

            \ "cpp": "g++",

            \ "c++": "g++",

            \ "javascript": "node",

            \ }

```

5. `org#main#runCodeBlock` is the function to run code block, and `org#main#runLanguage` is the function to run a language. You can refer befor example to bind you quick keys.

## Thanks

**Finally, floating window mainly refers to [vim-quickui](https://github.com/skywind3000/vim-quickui) of [Linwei](https://github.com/skywind3000). Thanks the excellent project provided by Linwei.**