# Conspectus

A live table of contents inside the note. Insert a `conspectus` block and it updates when headings change. The same block can appear in a Pagina PDF.

## Use

Open the command palette and run **Insert table of contents**, or add this block:

````markdown
```conspectus
title: Table of Contents
```
````

The table of contents is an unnumbered nested list of links to headings. Its title is not numbered by Ordinal Headings.

### Block options

| Key | Example | Meaning |
| --- | --- | --- |
| `title` | `title: Contents` | Heading above the list. Leave it empty for no title. |
| `level` | `level: 3` | Deepest heading this block includes |
| `export` | `export: false` | Hide this block in a Pagina PDF. It stays visible in the note. |
| `page-numbers` | `page-numbers: 2` | In a Pagina PDF, number entries through this heading level. `page-numbers: off` hides them. |
| `leaders` | `leaders: false` | Dotted leaders before the page number. The number stays at the right when this is off. |
| `break-before` | `break-before: true` | Start a new PDF page before the table of contents |
| `break-after` | `break-after: true` | Start a new PDF page after the table of contents |

## Settings

Open **Settings → Conspectus**.

| Setting | What it does |
| --- | --- |
| Max heading level | Default deepest heading for new blocks |
| Default title | Title used when a block does not set one |
| Show TOC in PDF export | Include the table of contents in Pagina PDFs |
| Page numbers up to heading level | Number contents entries through this level in a Pagina PDF. Off leaves the list unchanged. |
| Dot leaders | Dotted leaders before those page numbers |
| Indent per level | Extra indent, in em, for each level below the first. With alignment off, Heading 1 keeps the list indent and deeper levels step in from there. The default 1.25 puts the next level one step further in. |
| Align heading 1 with the title | On places Heading 1 on the same line as the title. Off, the default, keeps the list indent. |
| Render math in table of contents | Typeset math in contents entries. Off, the default, leaves the heading text as written. |
| Page break before TOC (PDF) | Default page break before the block |
| Page break after TOC (PDF) | Default page break after the block |

Under **Backup**, **Export settings** and **Import settings** save or restore that configuration as `conspectus-settings.json`.

## Support

[![Buy Me a Coffee](https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png)](https://buymeacoffee.com/aceofspadesomelette)

## Star history

[![Star History Chart](https://api.star-history.com/svg?repos=AceOfSpadesOmelette/obsidian-conspectus&type=Date)](https://www.star-history.com/#AceOfSpadesOmelette/obsidian-conspectus&Date)