I use LaTeX on my Mac for all my documents. I'm very happy with the MacTex installation I downloaded. I think it's a bundle of TeXLive for the Mac. I use Carbon Emacs for file writing and editing, I don't recall any installation or configuration problems getting it to work with LaTeX. TeX Live is intended to be a straightforward way to get up and running with the TeX document production system.It provides a comprehensive TeX system with binaries for most flavors of Unix, including GNU/Linux, macOS, and also Windows.It includes all the major TeX-related programs, macro packages, and fonts that are free software, including support for many languages around the world.
- Compiling from source
Automatic detection of MikTeX, TeX Live, Ghostscript, and Standardlatex; SVN support; Note: The OS X version is experimental. Since none of the currently active developers are using OS X, we cannot thoroughly test it. We do our best to also support OS X, but be prepared that there may be some issues. We recommend installing TeX Live via your package manager. (On Debian/Ubuntu, apt-get install texlive.) Chrome OS. On Chrome OS, pandoc can be installed using the chromebrew package manager with the command: crew install pandoc. This will automatically build and configure pandoc for the specific device you are using.
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.
Windows
There is a package installer at pandoc’s download page. This will install pandoc, replacing older versions, and update your path to include the directory where pandoc’s binaries are installed.
If you prefer not to use the msi installer, we also provide a zip file that contains pandoc’s binaries and documentation. Simply unzip this file and move the binaries to a directory of your choice.
Texlive For Mac Os 10.13
Alternatively, you can install pandoc using Chocolatey:
Chocolatey can also install other software that integrates with Pandoc. For example, to install rsvg-convert
(from librsvg, covering formats without SVG support), Python (to use Pandoc filters), and MiKTeX (to typeset PDFs with LaTeX):
By default, Pandoc creates PDFs using LaTeX. We recommend installing it via MiKTeX.
macOS
There is a package installer at pandoc’s download page. If you later want to uninstall the package, you can do so by downloading this script and running it with perl uninstall-pandoc.pl
.
Alternatively, you can install pandoc using Homebrew:
To include pandoc’s citation parser:
Homebrew can also install other software that integrates with Pandoc. For example, to install librsvg (its rsvg-convert
covers formats without SVG support), Python (to use Pandoc filters), and BasicTeX (to typeset PDFs with LaTeX):
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.
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 whatever directory you like.
By default, Pandoc creates PDFs using LaTeX. Because a full MacTeX installation uses four gigabytes of disk space, we recommend BasicTeX or TinyTeX and using the tlmgr
tool to install additional packages as needed. If you receive errors warning of fonts not found:
Linux
Check whether the pandoc version in your package manager is not outdated. Pandoc is in the Debian, Ubuntu, Slackware, Arch, Fedora, NiXOS, openSUSE, gentoo and Void repositories.
To get the latest release, we provide a binary package for amd64 architecture on the download page.
This provides both pandoc
and pandoc-citeproc
. The executables are statically linked and have 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.
Both a tarball and a deb installer are provided. To install the deb:
where $DEB
is the path to the downloaded deb. This will install the pandoc
and pandoc-citeproc
executables and man pages.
If you use an RPM-based distro, you may be able to install the deb from our download page using alien
.
On any distro, you may install from the tarball into $DEST
(say, /usr/local/
or $HOME/.local
) by doing
where $TGZ
is the path to the downloaded zipped tarball. For Pandoc versions before 2.0, which don’t provide a tarball, try instead
You can also install from source, using the instructions below under Compiling from source. Note that most distros have the Haskell platform in their package repositories. For example, on Debian/Ubuntu, you can install it with apt-get install haskell-platform
.
For PDF output, you’ll need LaTeX. We recommend installing TeX Live via your package manager. (On Debian/Ubuntu, apt-get install texlive
.)
Chrome OS
On Chrome OS, pandoc can be installed using the chromebrew package manager with the command:
This will automatically build and configure pandoc for the specific device you are using.
BSD
Pandoc is in the NetBSD and FreeBSD ports repositories.
Docker
The official Docker images for pandoc can be found at https://github.com/pandoc/dockerfiles and at dockerhub.
The pandoc/core image contains pandoc
and pandoc-citeproc
.
The pandoc/latex image also contains the minimal LaTeX installation needed to produce PDFs using pandoc.
To run pandoc using Docker, converting README.md
to README.pdf
:
GitHub Actions
Pandoc can be run through GitHub Actions. For some examples, see https://github.com/pandoc/pandoc-action-example.
Compiling from source
If for some reason a binary package is not available for your platform, or if you want to hack on pandoc or use a non-released version, you can install from source.
Getting the pandoc source code
Source tarballs can be found at https://hackage.haskell.org/package/pandoc. For example, to fetch the source for version 1.17.0.3:
Or you can fetch the development code by cloning the repository:
Note: there may be times when the development code is broken or depends on other libraries which must be installed separately. Unless you really know what you’re doing, install the last released version.
Quick stack method
The easiest way to build pandoc from source is to use stack:
Install stack. Note that Pandoc requires stack >= 1.7.0.
Change to the pandoc source directory and issue the following commands:
stack setup
will automatically download the ghc compiler if you don’t have it.stack install
will install thepandoc
executable into~/.local/bin
, which you should add to yourPATH
. This process will take a while, and will consume a considerable amount of disk space.
Quick cabal method
Install the Haskell platform. This will give you GHC and the cabal-install build tool. Note that pandoc requires GHC >= 7.10 and cabal >= 2.0.
Update your package database:
Check your cabal version with
If you have a version less than 2.0, install the latest with:
Use
cabal
to install pandoc and its dependencies:This procedure will install the released version of pandoc, which will be downloaded automatically from HackageDB.
If you want to install a modified or development version of pandoc instead, switch to the source directory and do as above, but without the ‘pandoc’:
Make sure the
$CABALDIR/bin
directory is in your path. You should now be able to runpandoc
:If you want to process citations with pandoc, you will also need to install a separate package,
pandoc-citeproc
. This can be installed using cabal:By default
pandoc-citeproc
uses the “i;unicode-casemap” method to sort bibliography entries (RFC 5051). If you would like to use the locale-sensitive unicode collation algorithm instead, specify theunicode_collation
flag:Note that this requires the
text-icu
library, which in turn depends on the C libraryicu4c
. Installation directions vary by platform. Here is how it might work on macOS with Homebrew:The
pandoc.1
man page will be installed automatically. cabal shows you where it is installed: you may need to set yourMANPATH
accordingly. IfMANUAL.txt
has been modified, the man page can be rebuilt:make man/pandoc.1
.The
pandoc-citeproc.1
man page will also be installed automatically.
Custom cabal method
This is a step-by-step procedure that offers maximal control over the build and installation. Most users should use the quick install, but this information may be of use to packagers. For more details, see the Cabal User’s Guide. These instructions assume that the pandoc source directory is your working directory. You will need cabal version 2.0 or higher.
Install dependencies: in addition to the Haskell platform, you will need a number of additional libraries. You can install them all with
Configure:
All of the options have sensible defaults that can be overridden as needed.
FLAGSPEC
is a list of Cabal configuration flags, optionally preceded by a-
(to force the flag tofalse
), and separated by spaces. Pandoc’s flags include:embed_data_files
: embed all data files into the binary (default no). This is helpful if you want to create a relocatable binary.https
: enable support for downloading resources over https (using thehttp-client
andhttp-client-tls
libraries).
Build:
Build API documentation:
Copy the files:
The default destdir is
/
.Register pandoc as a GHC package:
Package managers may want to use the
--gen-script
option to generate a script that can be run to register the package at install time.
Creating a relocatable binary
It is possible to compile pandoc such that the data files pandoc uses are embedded in the binary. The resulting binary can be run from any directory and is completely self-contained. With cabal, add -fembed_data_files
to the cabal configure
or cabal install
commands.
With stack, use --flag pandoc:embed_data_files
.
Running tests
Pandoc comes with an automated test suite. To run with cabal, cabal test
; to run with stack, stack test
.
To run particular tests (pattern-matching on their names), use the -p
option:
Or with stack:
It is often helpful to add -j4
(run tests in parallel) and --hide-successes
(don’t clutter output with successes) to the test arguments as well.
If you add a new feature to pandoc, please add tests as well, following the pattern of the existing tests. The test suite code is in test/test-pandoc.hs
. If you are adding a new reader or writer, it is probably easiest to add some data files to the test
directory, and modify test/Tests/Old.hs
. Otherwise, it is better to modify the module under the test/Tests
hierarchy corresponding to the pandoc module you are changing.
Running benchmarks
To build and run the benchmarks:
or with stack:
To use a smaller sample size so the benchmarks run faster:
To run just the markdown benchmarks:
Texlive For Mac Os High Sierra
I put the following information together to facilitate the installation of LaTeX to people who are new to LaTeX or who are moving to a different operating system.
The first thing that has to be mentioned when talking about installing LaTeX is that you will usually need two things:
- A LaTeX distribution and
- A LaTeX editor
The distribution contains the typesetting system as well as many packages that you may use sooner or later while writing LaTeX documents. The LaTeX distribution is provided by the LaTeX project and has different names for different operating systems (Linux: TeX Live (cross-platform), Mac OS X: MacTeX and Windows: proTeXt/MikTeX). These are among the more common ones, you may find other distributions. The TeX Live distribution is several hundred MBs (sometimes over 1GB, depending on the OS), so make sure you have a reasonable internet connection and some space on your hard-drive. A LaTeX distribution may or may not include a LaTeX editor. The editor is a personal choice, you can use a simple text editor. But since there are many good editors available for different operating systems why not use them. They provide LaTeX-specific functionality like code highlighting, some autocompletion, macros, automatic document generation, etc.
Linux
Distribution: According to the LaTeX project, most of the Linux distributions will include a TeX distribution, which are in some way or another different from TeX Live. Another possibility is to get TeX Live from the TeX user group website. I’m running Ubuntu and in the Synaptic Package Manager look for the “texlive” and “texlive-latex-extra” if you want some additional packages. For a minimal installation, choose “texlive-common” and for a full installation “texlive-full”.
Alternatively, you can also use the command line version to install TeX Live.
Windows Texlive
Alternatively, you can download the distribution yourself. The link will automatically refer you to the closest mirror (currently: texlive2012.iso, size: 2.31GB). By doing this, you will get the standard TeX Live distribution. Updates will be done differently than with the package that comes with the Linux distribution.
You will have the possibility to deselect parts of the distribution that you don’t want to be installed using the command-line interface. I quite like it, its simple and easy to use.
Editor: Linux has a few editors including Texmaker, winefish, Kile (KDE) and Latexila (GNOME) and of course Emacs. I leave it to you to find the one that’s ideal for you.
ps. Believe it or not, there is also a vim Latex-addon, called the vim latex-suite. Just in case you were looking for it :-).
Mac OS X
Distribution: The Tex Live distribution for Mac OS X is called MacTeX and can be downloaded from the TeX user group website. It contains TeX Live, TeXShop (see editors below) and other useful tools.
Editor: Personally, I have been using TeXShop most of the time, but there are other equally reasonable editors including Texmaker and TeXworks, a cross-platform GUI editor inspired by TeXShop.
Windows
Distribution: Under Windows, one of the common LaTeX distos is called proTeXt (MiKTeX + the editor TeXnicCenter) and is also provided by the TeX user group.
Mactex Mac Os 10.10
Editor: As mentioned, the proTeXt distribution already provides the Latex editor (TeXnicCenter). Another editor I know of for Windows is the Led.