nvimager

Inline markdown image/gif/video/pdf/LaTeX previewer for nvim using ueberzug.

Designed for use with vimwiki using markdown syntax.

Table of Contents

• Install
• Usage
• Maintainers
• Contributing
• License

Install

<details> <summary>Dependencies</summary>

• Üeberzug (Necessary)
• pdftoppm (PDF/LaTeX)
• ffmpeg (Video)
• imagemagick (GIF/Video)
• pdfTex (LaTeX)

</details> <details> <summary>nvimager</summary> Download using your preffered plugin manager, otherwise here are instructions for Vim-Plug.

1. Install junegunn/vim-plug.

2. Add plugin to vim-plug block in vimrc.

call plug#begin[]
  Plug 'mbpowers/nvimager'
call plug#end[]

3. Add keybinding in vimrc.

nmap <leader>qq <Plug>NvimagerToggle

4. Restart nvim, and run :PlugInstall.

</details>

Usage

Nvimager matches text in the buffer to the following patterns:

<details> <summary>Dynamic Previews</summary>

[name](file:path) or $ equation $

• Height is determined by number empty lines below (excluding line with EOF).
• Width is the width of the terminal.
• Will update on the fly on BufTextChanged.

</details> <details> <summary>Static Previews</summary>

[name](file:path)<!--widthxheight--> or TODO ~$ equation $<!--widthxheight-->~

• Width and height are measured in terminal cells.
• The html comment <!--comment--> is allowed either two or three hyphens per side.
• On creation a static image will insert filler text, consisting of full block characters, "█", in exactly the cells of the preview.
• Do not delete filler text! Filler text will be deleted upon BufWrite, deletion of the link pattern, or when nvimager is toggled off.
• Filler text is removed PreBufWrite and replaced PostBufWrite, so you don't have to toggle to avoid writing filler lines to your file.
• Do not have multiple static previews on one line!
• Must toggle nvimager to update size.

</details> <details> <summary>Block Previews</summary>

• TODO

</details>

Configuration

<details> <summary>Options</summary>

You can set these in your init.vim:

| option | default | description | |-------------------------|---------------|----------------------------------------------------| | nvimager#autostart | 0 | start on BufEnter? | | nvimager#title | 1 | print titles? | | nvimager#dynamic_scaler | 'fit_contain' | see Üeberzug | | nvimager#static_scaler | 'forced_cover'| see Üeberzug |

let g:nvimager#autostart = 0
let g:nvimager#title = 1
let g:nvimager#dynamic_scaler = 'fit_contain'
let g:nvimager#static_scaler = 'forced_cover'

</details>

Acknowledgements

<details> <summary>Scripts</summary>

vimg

animated_thumbnail_gen.sh

neovim-plugins-in-lua

</details>

Maintainers

@mbpowers

Contributing

PRs, issues and feature suggestion welcomed.

If editing the README, please conform to the standard-readme specification.

License

MIT © 2022 mbpowers