GithubHelp home page GithubHelp logo

wandmalfarbe / pandoc-latex-template Goto Github PK

View Code? Open in Web Editor NEW
5.8K 91.0 936.0 53.11 MB

A pandoc LaTeX template to convert markdown files to PDF or LaTeX.

License: BSD 3-Clause "New" or "Revised" License

TeX 94.17% Shell 5.83%
pandoc pandoc-template latex latex-template pdf pdf-generation markdown tex koma-script markdown-to-pdf

pandoc-latex-template's Introduction

Hi, my name is Pascal.

pandoc-latex-template's People

Contributors

0az avatar andre0512 avatar cagix avatar chrisfenner avatar daamien avatar davidmehren avatar enrico204 avatar evildead avatar garritfra avatar github-actions[bot] avatar jgrigera avatar khaveesh avatar ludvighz avatar martinlarsson avatar mfhepp avatar mprobson avatar noraj avatar pond avatar qjqqyy avatar ret2src avatar salim-b avatar shmalebx9 avatar slhck avatar sosiristseng avatar supcik avatar umanovskis avatar wandmalfarbe avatar wollanup avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

pandoc-latex-template's Issues

Backticks are not displayed in codeblocks.

If a codeblock contains Backticks, they are not displayed and pandoc outputs the following warning

[WARNING] Missing character: There is no ` in font SourceCodePro-Regular-tlf-ts1!

The issue can be reproduced with this example:

    expecting backtick here ->`<-

Compile with pandoc test.md -o test.pdf --template eisvogel --listings

Quoted blocks

Hi,

Thanks for the great template! It would be great to have an either box style > quoted block or a sideline "a la github". Currently using markdown quotes doesn't change any style.

Cheers,

Jun

Error producing PDF. ! LaTeX Error: Missing \begin{document} in Windows

Template works perfect in Linux environment. In Windows (7) unfortunately I get only the error message

Error producing PDF.
! LaTeX Error: Missing \begin{document}.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...

l.384   \kvsetkeys{mdf}{framemethod=default,}

Pandoc works fine with other templates. I tried the examples from github folder here with same result.

Book: Distinguish even/odd pages in header with twoside ...

Compiling the book example to produce a double-sided book using

sed 's/scrartcl/scrbook/g' < ../eisvogel.latex > ../eisvogel-book.latex
pandoc book/book.md -o book/book.pdf --from markdown --template ../eisvogel-book.latex --listings -V classoption=twoside --top-level-division=chapter 

In the generated output there is no difference between even and odd pages:
example-book-twosided

Please adjust your fancyhead settings to distinguish between even and odd pages in two-page mode.

Support multiple authors?

Hi, in the basic Pandoc template you can use multiple authors in the YAML metadata:

author:
  - Joe Bloggs
  - Joanne Bloggs

However, if I use multiple authors with your template then compiling the TeX file breaks:

! Misplaced \crcr.
\endarray ->\crcr
                  \egroup \egroup \gdef \@preamble {}\CT@end
l.289 ...\textsf{\uppercase{Joe Bloggs \and Joanne Bloggs}}

How to change default template settings?

Hello!

How can I change default template settings, like titlepage-color. titlepage-rule-color, listings-disable-line-number, etc?

Now I save those values in my .md files like that:

titlepage-color: ff0000
titlepage-rule-color: 00ff00
listings-disable-line-numbers: true
...

But as all my documents should look same, I need to add those lines in every source document.

This would ease document management.

Checked document management and wiki, but wasn't able to find how to change them.

Thank you a lot!

Idiomatic way to turn off page headers and footers?

Thanks for creating this template -- the resulting PDF documents are excellent.

Is there an idiomatic way to turn off page headers and footers in the resulting LaTeX/PDF? (This is for a smallish, special-purpose document).

page breaks on top level heading (h1 / #)

I really like this template.

I'm using it for a book I'm self-publishing. As I understand you are not specifically targeting books but since my book show sample C# code I need something to properly format the code and your template does the trick.

Using documentclass: book seems to break things so I've removed that.

I would like to place page breaks on the top level headings (# in my markdown). For that I've tried the titlesec package and include a header-includes to a titlesec.tex file with the following:

% titlesec setup
\usepackage{titlesec}
\newcommand{\sectionbreak}{\clearpage}

However, this results in the following error:

! LaTeX Error: Missing \begin{document}.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...

l.100 t

This is really my first outing with pandoc so any help would be appreciated. I have been struggling quite a while trying to get a decent output and I feel that I'm almost there :)

Does not compile on macOS

I am running pandoc 2.1.3 from homebrew. The commandline

pandoc xx.md -o xx.pdf --template eisvogel

results in the following error message:

"template" (line 626, column 111): unexpected "<" expecting letter

Bug or wrong usage? Can I help to fix this?

The content of xx.md:

---
title: "The Document Title"
author: [Example Author, Another Author]
date: 2017-02-20
tags: [Markdown, Example]
---

# Header 1

Lorem ipsum

# Header 2

Here is the actual document text

Error on footnotes

It seems there is some problem with blank lines on footnotes:

This code from MANUAL.txt:

[^subtitle]: To make `subtitle` work with other LaTeX
    document classes, you can add the following to `header-includes`:

        \providecommand{\subtitle}[1]{%
          \usepackage{titling}
          \posttitle{%
            \par\large#1\end{center}}
        }

Throws an error:

Runaway argument?
\providecommand {\subtitle }[1]{\usepackage {titling} \posttitle {
! Paragraph ended before \FV@BeginScanning was complete.
<to be read again> 
                  \par 
l.1457 }

But if I remove the first white line:

[^subtitle]: To make `subtitle` work with other LaTeX
    document classes, you can add the following to `header-includes`:
        \providecommand{\subtitle}[1]{%
          \usepackage{titling}
          \posttitle{%
            \par\large#1\end{center}}
        }

All goes well.

including external pdf

I have a document in markdown and i want to attach some other documents in pdf. I tried to add
header-includes: \usepackage{pdfpages} in the YAML preamble. This unfortunately gives me:

Error producing PDF.
! LaTeX Error: Option clash for package xcolor.

I have edited the template and added \usepackage{pdfpages} after the \usepackage{xcolor}stuff around line 430. This fixes the error for me but I am unsure if it is the right thing to do.

By the way, is there a way to include a PDF page in a Document so that it gets scaled down a bit and is surrounded by the page header and footer, numbering etc.?

Error producing PDF with **`#;`**

I am trying to convert a markdown file to a PDF using the Eisvogel template. My input file has lots of bold, italics, lists, backtick code sections and triple backtick code sections. Pandoc crashes when producing a PDF only containing **`#;`**.

Steps to Reproduce

  1. Create a .md file with contents:
**`#;`**
  1. Run pandoc example.md -o example.pdf --from markdown --template eisvogel --listings, where example.md is the name of the file

The error

When producing a markdown file named example.md with the contents

**`#;`**

and running pandoc example.md -o example.pdf --from markdown --template eisvogel --listings, I get the output

Error producing PDF.
! Illegal parameter number in definition of \reserved@a.
<to be read again>
                   ;
l.327 \textbf{\passthrough{\lstinline!#;!}}

Environment

Windows 10.

pandoc.exe 2.3
Compiled with pandoc-types 1.17.5.1, texmath 0.11.1, skylighting 0.7.2

Table row colors are starting at different colors for each table.

I have multiple Tables in my document, and the backgroundcolor alternates on them.

example-file

| Ja | Nein | Enthaltung |
|:--:|:----:|:----------:|
| 99 | 0    | 0          |

| Ja | Nein | Enthaltung |
|:--:|:----:|:----------:|
| 99  | 0    | 0          |

| Ja | Nein | Enthaltung |
|:--:|:----:|:----------:|
| 99 | 0    | 0          |

| Ja | Nein | Enthaltung |
|:--:|:----:|:----------:|
| 99 | 0    | 0          |

| Ja | Nein | Enthaltung |
|:--:|:----:|:----------:|
| 99 | 0    | 0          |

which results in
test pdf_-_adobe acrobat reader dc_2017-11-12_20-12-09

Contents on a single page

Maybe there should be an option to left contents on a single page.

I mentioned this in #3, but you didn't reply me for this point. Now I submit another issue report, since these are separate and independent issues.

Long lines without spacing aren't broken at all

(this issue might already have been adressed in #2)

Hey! I'm pretty new to both Pandoc and this project, so take my criticism with a hint of salt, but I'd love it if this template took care of breaking long words.

For example in an assignment I'm writing I needed to add a long link. I ended up having to shorten it with one of those online shorteners, but I'd love it if the template just took care of that.

Another usage example is long lines of code without spacing (XPath for. Ex.)

I'm not sure if this is within the scope of this project, but personally I'd love to see linebreaks handled more gracefully :)

XeLaTeX and Custom Title page

If I use XeLaTeX and your custom page, the blue background leaks into the next page. Compiling with LuaLaTeX of PDFTeX and it works fine.

screen shot 2017-05-26 at 20 56 56_small

Landscape orientation support request

Before requesting anything I would like to say thank you for a great template. It's pretty awesome!

I use this hack for now, but its doesn't look very good. The page footer disappears and the header doesn't get reach all the way. I use it mainly for big pictures and big tables.

\paperwidth=\pdfpageheight
\paperheight=\pdfpagewidth
\pdfpageheight=\paperheight
\pdfpagewidth=\paperwidth

\begingroup 
\vsize=\pdfpageheight
\hsize=\pdfpagewidth
\textwidth=\hsize
\textheight=\vsize
\begin{figure}
\centering
\includegraphics[width=0.8\paperwidth,height=.5\textheight]{use_case.png}
\caption{Use case diagram} \label{fig:use_case}
\end{figure}
\endgroup

\newpage
\paperwidth=\pdfpageheight
\paperheight=\pdfpagewidth
\pdfpageheight=\paperheight
\pdfpagewidth=\paperwidth
\headwidth=\textwidth

titlegraphic usage ?

Hi,

I'm no expert at all at latex, but it appears to be possible to insert a titlegraphic somehow...
Could anybody show me how that works cuz I fail miserably.

Tried:

  • full path
  • relative path
  • markdown format
  • html format

Thanks in advance

Error in custom-titlepage example (wrong color code)

Compiling the examples using Pandoc 2.2.3.2 there is an error in the custom-titlepage example:

wandmalfarbe-latex-template/examples$ sh -x build.sh 
+ set -e
+ cp ../eisvogel.tex ../eisvogel.latex
+ pandoc basic-example/basic-example.md -o basic-example/basic-example.pdf --from markdown --template ../eisvogel.latex --listings
+ pdftoppm -r 150 -png basic-example/basic-example.pdf
+ pandoc custom-titlepage/custom-titlepage.md -o custom-titlepage/custom-titlepage.pdf --from markdown --template ../eisvogel.latex --listings
Error producing PDF.
! Missing number, treated as zero.
<to be read again> 
                   f
l.339 \color[HTML]{ffffff}

It seems, that LaTeX is unhappy about the color code ffffff ...

Page break after TOC

Hello!

Currently when generating document with --toc option, there's no page break between TOC and document content itself, so I need to add \newpage to the each document to add page break.

Is it possible to edit template or add an option to do it automatically, so there will be no longer need to add \newpage to each document?

Thank you a lot!

Source Sans Pro isn't applied as a main font family when using XeLaTeX

Hi, if I supply a lang: en-GB or lang: en-US metadata field to your custom-titlepage example, the main body text is not source sans pro any more, but the latex default:

screen shot 2017-05-31 at 17 16 25

removing it and all is fine...

---
title: "Vinaque sanguine metuenti cuiquam Alcyone fixus"
author: [Author Name]
date: 2017-02-20
subject: "Markdown"
tags: [Markdown, Example]
subtitle: "Aesculeae domus vincemur et Veneris adsuetus lapsum"
titlepage: true
titlepage-color: eeeeee
titlepage-text-color: ffffff
titlepage-rule-color: ffffff
titlepage-rule-height: 1
lang: en-GB
...

Disable numbering in listings

Would be great to have an option to have nice listings (including background color, syntax highlight, border, etc), but without line numbering, or have them in a separate column.

The problem is I have some Linux commands listed in those listings, and I wish just to copy them entirely. But they are selected and copied with numbers, so I cannot paste them into terminal directly.

Maybe just need to edit source a bit to disable them?

Thanks for amazing document tho, great job!

Add cover support

If I use this template to generate a long articles or notes. A cover and back cover support will be nice!

geometry package usage defined twice when "geometry" variable is set in yaml or -M option

in eisvogel.latex:

  • lines 158-160:
$if(geometry)$
\usepackage[$for(geometry)$$geometry$$sep$,$endfor$]{geometry}
$endif$
  • line 375:
\usepackage[$if(papersize)$$papersize$paper,$else$a4paper,$endif$margin=2.5cm,includehead=true,includefoot=true,centering]{geometry}

line 375 defines geometry options while 158 also does it when geometry is defined in yaml header
or by -M option. 158 and 375 should be exclusive.

I think 375 overrides 158 but one would be warned like this

! LaTeX Error: Option clash for package geometry.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...

l.218

?

and this

LaTeX Warning: There were multiply-defined labels.

Add support for tikz

Would it be possible to add support for tikz, so that projects like pandoc-filter-graphviz
can be used with this template ? I made an pull request with my changes to the code base #37 .

It would then be possible to create tikz-pictures using pandoc filters, like:

pandoc -F ./pandoc-filter-graphviz example.md -o example.pdf --from markdown --template eisvogel --listings -V tikz

Add support for a cover page

It would be nice if there would be an option to generate a cover page along with a title page.
The cover page would have a bit less information. One of the pieces of information that would
not be shown is de date. This would be immenseley helpful.

An idea to this to maybe have a look the CoverPage package. This package provides an easy way to generate a cover page.

Ordered lists generate LaTeX error "missing item"

For example trying the basic example:

pandoc --from markdown --template eisvogel -i basic-example.md -o output.pdf

Gives following error output:

Error: Something's wrong--perhaps a missing \item.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...                                              
                                                  
l.357   D
         e neque iura aquis

./output.tex:357: LaTeX Error: Something's wrong--perhaps a missing \item.

See the LaTeX manual or LaTeX Companion for explanation.
Type  H <return>  for immediate help.
 ...                                              
                                                  
l.357   D
         e neque iura aquis

Seems that the error occurs when using numbered lists. For example:

  1. first test list item
  2. second test list item

I'm running the command in windows 10, pandoc version 2.2.1 and MikTex 2.9

Table does not wrap properly

Tables with a lot of data do not wrap properly causing some columns to not be viewable. Ex

Column Description
AAAAAA ZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZ ZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZ ZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZ ZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZ
BBBBB ZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ Z ZZZZZZZZZZZZZZ

File eisvogel.latex not found in resource path

I have eisvogel.latex (renamed from eisvogel.tex) in $HOME/.pandoc/templates.

When I run pandoc my.md -o my.pdf --from markdown --template eisvogel --listings I get the error:

File eisvogel.latex not found in resource path

Please advise.

Add background to inline code

Hey, still a big fan of this template,

I was just wondering if there is a way to add a background to inline code rather than color, like this.

custom-titlepage examples fail to compile on latest version

Recently I wanted to recompile an old assignment, and found it constantly failed, printing this:

pandoc: Prelude.read: no parse

After trying to bisect pandoc, I realised the problem came from the titlepage declarations in the document's YAML header. The problem is fixed by quoting the values as follows:

titlepage: true
titlepage-color: '06386e'
titlepage-text-color: 'ffffff'
titlepage-rule-color: 'ffffff'
titlepage-rule-height: 1

Setting link, cite, URL color with HTML-style values?

Thanks for the great template!

I see that there are additional options that could be set, e.g.: linkcolor, citecolor, urlcolor. However, setting them as additional variables like the title page color etc. does not work, as they only seem to take xcolor names, not HTML-style FFFFFF values:

Error producing PDF.
! Package xcolor Error: Undefined color `006666'.

See the xcolor package documentation for explanation.

Color for table rows is applied to some table-like environments.

Table row coloring is used in some environments like array or cases where no coloring is expected.

\begin{equation}
\ref{eq:pos-clamping-complete}
x_d \notin [x_{min}, x_{max}] \Rightarrow 
\begin{cases}
& v_d \leftarrow 0\\
x_d < x_{min} \Rightarrow & x_d \leftarrow x_{min}\\
x_d > x_{max} \Rightarrow & x_d \leftarrow x_{max}\\
\end{cases}
\end{equation}

screen shot 2018-02-28 at 22 14 50

Use the template in a thesis-like project

Let me point out that I'm quite new to the TeX world.
Is it possible to use such a template in a thesis-like project? More specifically I'd like to add a few things to the template:

  • Some kink of logo to the first page
  • A table of content that keeps track of the markdown headers (in a multi-markdown numbered pages scenario )
  • being able to add one (or more) footnotes to the pages

Thanks.

Chapters look strange.

I never really tested chapters with my template so there are some strange chapter headings:

screenshot 2017-10-29 13 41 13

xcolor error when setting `colorlinks` latex variable

When I set the colorlinks latex variable for pandoc in combination with the eisvogel template, like so

pandoc foo.md -o foo.pdf --template eisvogel/eisvogel.tex --listings -V colorlinks

then I get the following error:

Error producing PDF.
! Package xcolor Error: Undefined color `Maroon'.

See the xcolor package documentation for explanation.

Looking at the template code, I found that if I set the linkcolor variable it to one of the basic latex colors then it does work, i.e.

pandoc foo.md -o foo.pdf --template eisvogel/eisvogel.tex --listings -V colorlinks -V linkcolor=blue

works.

If I set it other colors defined by xcolor then it again fails with the same error.

I'm using pandoc 2.1.3, TexLive 2017 on macOS and eisvogel at fd7a45b.

Thanks for creating this cool template ๐Ÿป :)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.