m

minitoc

@preview

An outline function just for one section and nothing else

v0.1.0
GPL-3.0-only

Package Information

Last Updated
Authors
nxe

1. Get the package

Download the package using the TPIX CLI:

tpix get @preview/minitoc:0.1.0

2. Import in your Typst file

Add this to your .typ file:

#import "@preview/minitoc:0.1.0": *

Version History

0.1.0
71a3d337e718...

Typst miniTOC

This package provides the minitoc command that does the same thing as the outline command but only for headings under the heading above it.

This is inspired by minitoc package for LaTeX.

Example

#import "@preview/minitoc:0.1.0": *
#set heading(numbering: "1.1")

#outline()

= Heading 1

#minitoc()

== Heading 1.1

#lorem(20)

=== Heading 1.1.1

#lorem(30)

== Heading 1.2

#lorem(10)

= Heading 2

This produces

Usage

The minitoc function has the following signature:

#let minitoc(
  title: none, target: heading.where(outlined: true),
	depth: none, indent: none, fill: repeat([.])
) { /* .. */ }

This is designed to be as close to the outline funtions as possible. The arguments are:

  • title: The title for the local outline. This is the same as for outline.title.
  • target: What should be included. This is the same as for outline.target
  • depth: The maximum depth different to include. For example, if depth was 1 in the example, "Heading 1.1.1" would not be included
  • indent: How the entries should be indented. Takes the same types as for outline.indent and is passed directly to it
  • fill: Content to put between the numbering and title, and the page number. Same types as for outline.fill

Unintended consequences

Because minitoc uses outline, if you apply numbering to the title of outline with #show outline: set heading(numbering: "1.") or similar, any title in minitoc will be numbered and be a level 1 heading. This cannot be changed with #show outline: set heading(level: 3) or similar unfortunately.