From 24fdff692b96dfeb85b39f45e1a9ba194713c7fc Mon Sep 17 00:00:00 2001 From: Ian Max Andolina Date: Mon, 19 Aug 2024 15:41:30 +0800 Subject: [PATCH 1/2] Update INSTALL.md See #10069 -- the static linked pandoc on other OSes also have a limitation to use binary lua packages. So added this point at the top of the document. In addition conda-forge is cross-platform way to install pandoc and other tools, added to Windows, macOS and Linux sections. I wrapped at 75 characters, is that right? --- INSTALL.md | 46 +++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 41 insertions(+), 5 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 52d06b05e6af..315e5c37207c 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -7,8 +7,10 @@ The simplest way to get the latest pandoc release is to use the installer. Download the latest installer -For alternative ways to install pandoc, see below -under the heading for your operating system. +For alternative ways to install pandoc, see below under the heading for +your operating system. In cases where a statically linked executable is +installed, the pandoc binary from this package cannot use lua filters that +require external lua modules written in C. ## Windows @@ -39,6 +41,18 @@ Or, you can install pandoc using winget install --source winget --exact --id JohnMacFarlane.Pandoc +Or, you can install pandoc using a [Conda +forge](https://anaconda.org/conda-forge/pandoc) tool, like +[`conda`](https://conda.pydata.org/docs/intro.html), +[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or +[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other +packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via +`librsvg` etc.). Note this is a statically-linked executable: + + conda install -c conda-forge pandoc + pixi global install pandoc + micromamba install pandoc + Using multiple installation methods can result in two separate installations of pandoc; it is recommended to properly uninstall pandoc before switching to an alternative installation method. @@ -70,6 +84,18 @@ Note: On unsupported versions of macOS (more than three releases old), Homebrew installs from source, which takes additional time and disk space for the `ghc` compiler and dependent Haskell libraries. +Or, you can install pandoc using a [Conda +forge](https://anaconda.org/conda-forge/pandoc) tool, like +[`conda`](https://conda.pydata.org/docs/intro.html), +[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or +[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other +packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via +`librsvg` etc.). Note this is a statically-linked executable: + + conda install -c conda-forge pandoc + pixi global install pandoc + micromamba install pandoc + We also provide a zip file containing the binaries and man pages, for those who prefer not to use the installer. Simply unzip the file and move the binaries and man pages to @@ -97,9 +123,7 @@ architecture on the **[download page]**. The executable is statically linked and has no dynamic dependencies or dependencies on external -data files. Note: because of the static -linking, the pandoc binary from this package cannot use lua -filters that require external lua modules written in C. +data files. Both a tarball and a deb installer are provided. To install the deb: @@ -122,6 +146,18 @@ a tarball, try instead ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $DEST +Or, you can install pandoc using a [Conda +forge](https://anaconda.org/conda-forge/pandoc) tool, like +[`conda`](https://conda.pydata.org/docs/intro.html), +[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or +[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other +packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via +`librsvg` etc.). Note this is a statically-linked executable: + + conda install -c conda-forge pandoc + pixi global install pandoc + micromamba install pandoc + You can also install from source, using the instructions below under [Compiling from source]. Note that most distros have the Haskell platform in their From 1f2555504b0d0a870be3dcd51a77886236985148 Mon Sep 17 00:00:00 2001 From: iandol Date: Wed, 28 Aug 2024 16:50:22 +0200 Subject: [PATCH 2/2] refactor to use a conda forge section --- INSTALL.md | 63 ++++++++++++++++++++++-------------------------------- 1 file changed, 26 insertions(+), 37 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 315e5c37207c..344c718fb0f2 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -8,9 +8,13 @@ The simplest way to get the latest pandoc release is to use the installer. For alternative ways to install pandoc, see below under the heading for -your operating system. In cases where a statically linked executable is -installed, the pandoc binary from this package cannot use lua filters that -require external lua modules written in C. +your operating system. + +**Note**: the statically linked Pandoc binaries provided by us (or those +available on Conda Forge) have a limitation. They are unable to utilise Lua +filters that rely on Lua modules written in C. If you require the +functionality offered by these filters, please consider an alternative +method of installation. ## Windows @@ -35,23 +39,13 @@ without SVG support), [Python] (to use Pandoc filters), and [MiKTeX] (to typeset PDFs with [LaTeX]): choco install rsvg-convert python miktex - + Or, you can install pandoc using [winget](https://github.com/microsoft/winget-pkgs): winget install --source winget --exact --id JohnMacFarlane.Pandoc -Or, you can install pandoc using a [Conda -forge](https://anaconda.org/conda-forge/pandoc) tool, like -[`conda`](https://conda.pydata.org/docs/intro.html), -[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or -[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other -packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via -`librsvg` etc.). Note this is a statically-linked executable: - - conda install -c conda-forge pandoc - pixi global install pandoc - micromamba install pandoc +Or, you can install Pandoc using [Conda forge]. Using multiple installation methods can result in two separate installations of pandoc; it is recommended to properly uninstall @@ -84,17 +78,7 @@ Note: On unsupported versions of macOS (more than three releases old), Homebrew installs from source, which takes additional time and disk space for the `ghc` compiler and dependent Haskell libraries. -Or, you can install pandoc using a [Conda -forge](https://anaconda.org/conda-forge/pandoc) tool, like -[`conda`](https://conda.pydata.org/docs/intro.html), -[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or -[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other -packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via -`librsvg` etc.). Note this is a statically-linked executable: - - conda install -c conda-forge pandoc - pixi global install pandoc - micromamba install pandoc +Or, you can install Pandoc using [Conda forge]. We also provide a zip file containing the binaries and man pages, for those who prefer not to use the installer. Simply @@ -146,17 +130,7 @@ a tarball, try instead ar p $DEB data.tar.gz | tar xvz --strip-components 2 -C $DEST -Or, you can install pandoc using a [Conda -forge](https://anaconda.org/conda-forge/pandoc) tool, like -[`conda`](https://conda.pydata.org/docs/intro.html), -[`[micro]mamba`](https://mamba.readthedocs.io/en/latest/index.html) or -[`pixi`](https://prefix.dev). Conda forge contains multiple LaTeX and other -packages (including `pandoc-citeproc`, `pandoc-plot`, `rsvg-convert` via -`librsvg` etc.). Note this is a statically-linked executable: - - conda install -c conda-forge pandoc - pixi global install pandoc - micromamba install pandoc +Or, you can install Pandoc using [Conda forge]. You can also install from source, using the instructions below under [Compiling from source]. @@ -186,6 +160,21 @@ device you are using. Pandoc is in the [NetBSD], [FreeBSD], and [OpenBSD ports] repositories. +## Conda Forge + +You can install Pandoc using a [Conda +Forge](https://anaconda.org/conda-forge/pandoc) tool, like +[Conda](https://conda.pydata.org/docs/intro.html), +[[Micro]Mamba](https://mamba.readthedocs.io/en/latest/index.html) or +[Pixi](https://prefix.dev). Conda forge also includes multiple LaTeX and +other relevant packages for Pandoc (including `pandoc-citeproc`, +`pandoc-plot`, `rsvg-convert` via `librsvg` etc.). **Note:** conda forge +installs a statically-linked executable. + + conda install -c conda-forge pandoc + pixi global install pandoc + micromamba install pandoc + ## Docker The official Docker images for pandoc can be found at