Pandoc - Inserting pages before generated Table of Contents

Question

I've been playing around with Pandoc.

Is there anyway to insert pages before the generated Table of Contents?

For example:

Title Page
Insert Custom Page 001
Insert Custom Page 002
(Generated) Table of Contents

Many thanks in advance!

yes, have a look at http://johnmacfarlane.net/pandoc/README.html#templates — mb21, Sep 02 '14 at 14:20
Why does @mb21's comment have upvotes? It is pretty useless without details. — gwg, Jun 27 '20 at 20:04

score 9 · Answer 1 · edited Mar 25 '20 at 19:31

I am guessing you want to create a HTML File with Title Page or Header Information. The solution is to do it in more than one Step.

First you compile the Title Page together any other pages to one html.

$ pandoc .\01_HEADER.markdown -o header.html

Then you include that header.html before the body:

$ pandoc -s -S --toc -B .\header.html .\02_Document.markdown -o complete_doc.html

Done.

The pandoc help states it's possibilities to make multi-part documents possible, both -B and -H work, but i think -B is more correct in my case.

  -H FILENAME           --include-in-header=FILENAME                    
  -B FILENAME           --include-before-body=FILENAME                  
  -A FILENAME           --include-after-body=FILENAME

In my case i do it with a stylesheet and get a perfect document:

$ pandoc -s -S -c .\res\github-pandoc.css .\01_HEADER.markdown -o header.html
$ pandoc -s -S --toc --toc-depth=2 -c .\res\github-pandoc.css -B .\header.html .\02_Document.markdown -o complete_document.html

score 8 · Answer 2 · answered Oct 04 '16 at 13:11

For this answer, I'm going to assume you are generating markdown, though the process is the same for other file formats as well.

The key insight is that Pandoc uses templates to determine the final placement. It has default templates and if you modify them, you can change the order of sections.

Find the default template

> pandoc -D markdown
$if(titleblock)$
$titleblock$

$endif$
$for(header-includes)$
$header-includes$

$endfor$
$for(include-before)$
$include-before$

$endfor$
$if(toc)$
$toc$

$endif$
$body$
$for(include-after)$

$include-after$
$endfor$

You won't need this for the next step, but if you are curious where these files live, asking for a nonsense file type works (though I'm sure there is a better way):

> pandoc -D nonsense
pandoc: Could not find data file /usr/local/.../templates/default.nonsense

Copy and modify the default template
```
> pandoc -D markdown > modified.markdown
```
Using your favorite text editor, you can open modified.markdown to put the $body$ before the $toc$ .
```
$body$
$if(toc)$
$toc$
$endif$
```

Use the modified template

> pandoc --template modified.markdown <... rest of your command ...>

I'm not sure this is what the OP is asking for: they want to add some custom pages before the TOC, but not the whole body, which should still appear after. — scoa, Oct 04 '16 at 19:55
Yes, this answer doesn't really take into account that the body should still come **after** the TOC. I'd like to create a title page in Markdown which should come before the TOC. Is this possible? — Joshua Muheim, Dec 08 '16 at 12:21

Tinmarino · Answer 3 · 2020-05-27T02:03:05.773

4

Use the include-before tag you can observe in the output of pandoc --print-default-template=markdown

---
title: My Way
toc: true
include-before: |
    See these lines
    Come __before__ the [toc](/dev/null)
---

# I've lived a life that's full
# I traveled each and every highway
# But more, much more than this
# I did it my way

edited May 27 '20 at 02:03

answered May 21 '20 at 21:11

Tinmarino

2,995
17
30

1

Excellent, thanks! You can also add `toc: true` to the YAML section, instead of adding the `--toc` argument. For multi-line (and multi-paragraph) text, use `include-before: |`, and add a set of identically indented lines after. – Cris Luengo May 26 '20 at 17:22
Thank you, @CrisLuengo, I did not know all that. I update the post. – Tinmarino May 27 '20 at 02:02

score 2 · Answer 4 · answered Jun 27 '20 at 20:18

None of these solutions worked for me, and one top-level comment suggested using Pandoc templates without details. So here's a simple fix.

Download the default Pandoc template from here: https://github.com/jgm/pandoc-templates, e.g. I used default.tex but renamed it template.tex.

Modify the template to insert additional content, create new pages, etc. e.g.:

\input{title.tex}
\newpage
\input{acknowledgements.tex}
\newpage

$if(toc)$
$if(toc-title)$
\renewcommand*\contentsname{$toc-title$}
$endif$

\newpage

Use this modified template rather than the default template, e.g.
```
pandoc --template=template.tex -o document.pdf document.tex`.
```

That's it.

Pandoc - Inserting pages before generated Table of Contents

4 Answers4

Linked