Skip to content
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.

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

table of contents, doc needed #283

Closed
Keksoj opened this issue Feb 23, 2022 · 1 comment
Closed

table of contents, doc needed #283

Keksoj opened this issue Feb 23, 2022 · 1 comment

Comments

@Keksoj
Copy link

Keksoj commented Feb 23, 2022

The README documentation provides the toc-own-page variable to be set at the beginning of the markdown document:

toc-own-page (defaults to false)
begin new page after table of contents, when true

But doing this:

---
title: "my title"
author: "myself"
titlepage: true

toc-own-page: true
---

will NOT work. I had to dive into eisvogel.tex to find out about toc and toc-title. Doing this:

---
title: "my title"
author: "myself"
titlepage: true

toc: true
toc-title: "Sommaire"
toc-own-page: true
---

DOES work.

toc and toc-title should be added in the official documentation.

@Wandmalfarbe
Copy link
Owner

The variables toc and toc-title are already part of the pandoc manual. I only document options that are added to the default template.

By default, pandoc does not generate a table of contents. The following code

---
title: "my title"
author: "myself"
titlepage: true

toc-own-page: true
---

does not produce a new page after the toc because there is no toc. If you want your documents with a table of contents, you can use --toc on the command line or add toc: true to your YAML front matter. In this case, the option toc-own-page should work as expected. I agree that this can be mentioned in the documentation. Perhaps an example is useful.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants