Skip to content

Preview plantuml inside Neovim! Inline preview in markdown support!

Notifications You must be signed in to change notification settings

v1nh1shungry/plantuml-preview.nvim

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 

Repository files navigation

plantuml-preview.nvim

Real-time preview

Inline preview

🎉 Features

  • Real-time preview plantuml right in neovim
  • Inline preview in markdown code block

NOTE: The function relies on the PlantUML Web Server's service, so you have to be connected. Thus, it may be unsafe.

📦 Installation

Require Neovim >= 0.11

💤 lazy.nvim

{
    'v1nh1shungry/plantuml-preview.nvim',
    keys = { { '<Leader>up', function() require('plantuml-preview').toggle() end }, desc = 'Preview plantuml' },
    opts = {},
}

⚙️ Configuration

Make sure you have called require('plantuml-preview').setup() before you use the plugin!

-- default configuration
{
    markdown = {
        enabled = true, -- whether to enable inline preview
        hl_group = 'Normal', -- highlight group for the preview
    },
    win_opts = { -- config which will be passed to `vim.api.nvim_open_win`
        split = 'right',
        win = 0,
        style = 'minimal',
    },
}

🚀 Usage

  • toggle(): toggle the preview

About

Preview plantuml inside Neovim! Inline preview in markdown support!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages