Skip to content

eduardotlc/telescope_kitty_preview.nvim

Repository files navigation

Telescope-du-preview.nvim

Kitty PDF, PNG, SVG and other formats preview in FZF and telescope.

mitbadge     Updated - April 2024

[email protected] [2024]

Current under developement, still not working, do not install this Plugin

If interested in this plugin, star it to follow future updates, until it is properly functioning

Renders preview through icat, imagemagick, pdftoppm and pygmentize.

Currently, being primary developed on neovim/telescope and kitty terminal. Despite that, other terminal emulators are schemed for future support, like iterm and gnome-terminal, though their support is not this project main focus.

If you desire contributing for this other terminals support, or any other code improve, fell free to submit a pull request, your help will be highly appreciated.

  1. Requirements

    1.1 Fedora

    1.2 Debian and Ubuntu

    1.3 Plugins

    1.3.1 Markdown utils

  2. Installation

  3. Setup

  4. Configuration

  5. Features

  6. Credits

  7. TODO

Requirements

Fedora Linux

sudo dnf install fzf gawk kitty poppler

Debian and Ubuntu Linux

sudo apt install fzf gawk kitty libpoppler-dev

Plugins

Vim-plug

Add to your init.vim

Plug 'nvim-lua/popup.nvim'
Plug 'nvim-lua/plenary.nvim'
Plug 'nvim-telescope/telescope.nvim'

Markdown utils

To use the FZF markdown utils and funtions, it is required:

Plug 'iamcco/markdown-preview.nvim', { 'do': 'cd app && yarn install' }
npm install -g npx

Installation

Vim-plug

Add to your init.vim

Plug 'eduardotlc/telescope-du-preview.nvim'

Setup

(Obrigatory)

On a lua file required by your init.vim:

require("telescope").setup({
  extensions = {
    du_preview = {},
    },
})

require("telescope").load_extension("du_preview")

For example, if you add the above code to a config.lua file, on your ~/.config/nvim/ folder, add the following to your init.vim:

lua require("config")

Configuration

  • Configuration folder and files are created during the exec of install.sh

Features

Preview Kitty Telescope Neovim Gnome-terminal iterm
SVG
PNG
PDF
Text Files
Todo.txt
epub
Bib Managing
Zotero Cites

Environment Variables

  • KITTY_TELESCOPE_BOOKMARKS

Bookmarks storing file path, defaults to ~/.kitty_bookmarks, needs to be formatted like:

Name: /file/base/path
Downloads: ~/Downloads
Desktop: /usr/local/share/applications

Credits

based on telescope-media-preview

TODO

  • Implement sioyek PDF open

  • Implement Zotero browser

  • Implement bibtex browser

  • Neovim checkhealth

  • Terminal and nvim fzf dictionary consulting and spell checking

  • Bibtex managing and citing

  • Zotero citing

About

Kitty pdf and image preview telescope extension

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published