Skip to content

docs: document Ghostscript requirement for PDF rendering #381

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
3rd merged 1 commit into from
Aug 19, 2026
+13 −2
Merged

docs: document Ghostscript requirement for PDF rendering #381

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<details>
<summary>NixOS</summary>

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)).

- <details>
Expand All @@ -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
};
}
Expand All @@ -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 {
Expand Down Expand Up @@ -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
};
Expand All @@ -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
};
Expand Down
Loading