From 0c53ab39176cf348c308d31e7a78674be33c0663 Mon Sep 17 00:00:00 2001 From: 3rd <3rd@users.noreply.github.com> Date: Wed, 19 Aug 2026 23:07:13 +0300 Subject: [PATCH] docs: document Ghostscript requirement for PDF rendering Changes: - explain why rendering PDF files requires Ghostscript - add Ghostscript to NixOS dependency examples --- README.md | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ac75a1a..08ff44e 100644 --- a/README.md +++ b/README.md @@ -64,10 +64,13 @@ For the `magick_cli` processor (default) you need a regular installation of Imag \ For the `magick_rock` processor you need to install the development version of ImageMagick. +Rendering PDF files also requires Ghostscript because ImageMagick uses it to decode and rasterize PDF content. +
NixOS NixOS users need to install the `imagemagick` package. +To render PDF files, add `ghostscript` to Neovim's `PATH`. For `magick_rock` you need to install `luajitPackages.magick` as well ([thanks](https://github.com/NixOS/nixpkgs/pull/243687) to [@donovanglover](https://github.com/donovanglover)). -
@@ -82,7 +85,10 @@ For `magick_rock` you need to install `luajitPackages.magick` as well ([thanks]( programs.neovim = { enable = true; extraLuaPackages = ps: [ ps.magick ]; - extraPackages = [ pkgs.imagemagick ]; + extraPackages = [ + pkgs.imagemagick + pkgs.ghostscript # Required only when rendering PDF files + ]; # ... other config }; } @@ -100,7 +106,10 @@ For `magick_rock` you need to install `luajitPackages.magick` as well ([thanks]( let config = pkgs.neovimUtils.makeNeovimConfig { extraLuaPackages = p: [ p.magick ]; - extraPackages = p: [ p.imagemagick ]; + extraPackages = p: [ + p.imagemagick + p.ghostscript # Required only when rendering PDF files + ]; # ... other config }; in { @@ -196,6 +205,7 @@ NixOS users need to install the `ueberzugpp` package. extraPackages = [ pkgs.ueberzugpp pkgs.imagemagick + pkgs.ghostscript # Required only when rendering PDF files ]; # ... other config }; @@ -215,6 +225,7 @@ NixOS users need to install the `ueberzugpp` package. extraPackages = p: [ p.ueberzugpp p.imagemagick + p.ghostscript # Required only when rendering PDF files ]; # ... other config };