Skip to content

Kurama622/markdown-org

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Markdown-Org

vim

ENGLISH | 中文版

Show

codeblock

language

More screenshots

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:

{
  "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 = {
    { "<leader>mr", "<cmd>call org#main#runCodeBlock()<cr>" },
    { "<leader>ml", "<cmd>call org#main#runLanguage()<cr>" },
  },
},

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

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

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

[[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.

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 border0
border1 border1
border2 border2
border3 border3
border4 border4
border5 border5

Custom Parameters and Quick Keys Settings

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

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 <silent> <M-b> :call org#main#runCodeBlock()<CR>
nnoremap <silent> <M-l> :call org#main#runLanguage()<CR>
  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:

let g:language_path = {
            \ "python":"/usr/bin/python",
            \ "python3":"python3",
            \ "go": "go",
            \ "c": "gcc",
            \ "cpp": "g++",
            \ "c++": "g++",
            \ "javascript": "node",
            \ }
  1. 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 of Linwei. Thanks the excellent project provided by Linwei.

Releases

No releases published

Packages

No packages published