niuiic/typst-preview.nvim

github github
programming-languages-support
stars 29
issues 0
subscribers 1
forks 0
CREATED

2023-09-17

UPDATED

13 days ago


typst-preview.nvim

Neovim plugin to preview typst document.

More neovim plugins

Usage

  1. Setup typst-lsp. (see example here)

  2. Call require("typst-preview").preview().

How it works

  1. Generate pdf files by typst compile.
  2. Respond to subsequent file changes with typst-lsp.
  3. Redirect these pdf files to a fixed path when you switch buffer.
  4. Preview this pdf by a pdf viewer with the ability to respond to the file changes.

Dependencies

Config

Default configuration here.

{
    -- file opened by pdf viewer
    output_file = function()
        local core = require("core")
        return core.file.root_path() .. "/output.pdf"
    end,
    -- how to redirect output files
    redirect_output = function(original_file, output_file)
        vim.cmd(string.format("silent !ln -s %s %s", original_file, output_file))
    end,
    -- how to preview the pdf file
    preview = function(output_file)
        local core = require("core")
        core.job.spawn("mimeopen", {
            output_file,
        }, {}, function() end, function() end, function() end)
    end,
    -- whether to clean all pdf files on VimLeave
    clean_temp_pdf = true,
}

Notice

Shell commands ln and mimeopen are used by default. You may need alternatives if they don't exist.

The first time you execute mimeopen command, it requires you to set the default application, please run the command manually first, complete the settings before using the plugin.

It is recommended to enable this plugin as soon as reading a typst file, or temp pdf files cannot be cleaned completely.

Compare to other tools

typst-live is awesome. However, severe flickering occurs when the file is updated. This is the limitation of the browser. In addition, it cannot switch files.

chomosuke/typst-preview.nvim supports cross jumping between code and preview, but does not support file switching yet. It should be noted that typst-preview used by this plugin implements the rendering logic itself instead of using official tools.