Table of Contents

Sketch Plugin for creating a Table of Contents artboard automatically.

v1.2.0 is compatible with Sketch 0.0.0

Table-of-Contents

Updates (1/28): Made the plugin compatible with Sketch 53 beta.

This is a Sketch Plugin I created upon a request from our Mozilla UX team. As a memember of the UX team we usually have to create different specs using Sketch, and we have to manually add a "Table of Contents" page to list out the contents. For this plugin you can just press the shortcut and it will automatically generate a Table of Contents page for you. (There are some rules to follow when you create your spec.)

Create ToC Menu ToC Artboard

Artboads Setup

  1. Artboard size: larger than 1440 x 1024 preferred.
  2. Artboard order: top first (Export as PDF order).
  3. Having a Cover as the first artboard & Release Notes or Version History as the second (Support multiple version history pages now).

Titles Setup

  1. Use Folders named "Header1" & "Header2" as first level titles & second level titles.

Titles Setup

Example File structure

  1. Cover
  2. Release Notes
  3. Topic A (using Header1)
  4. Topic A-1 (using Header2)
  5. Topic A-2 (using Header2)
  6. Topic A-3 (using Header2)
  7. Topic B (using Header1)
  8. Topic B-1 (using Header2)
  9. Topic B-2 (using Header2)
  10. Topic C (using Header1)
    ...

File Structure

Checkout the Example Sketch file for more information: https://github.com/youwenliang/Table-of-Contents/blob/master/Example.sketch Table of Contents will be generated after the Cover artboard.
Shortcut: control + option + ⌘command + T

Additional Options:

You can change the artboard background color, or change the margin and font size according to the amount of your contents.

Refresh / Delete your ToC:

If you've already generated a Table of Contents, you can click the button (control + option + ⌘command + T) again to refresh or delete your current Table of Contents.

Options


Join the discussion

Download v1.2.0
Usage Activity
400100

No Sketchpacks Relay integration found

Stats
  • 164 downloads all–time
  • 0 downloads this week
  • 7 downloads this month
About this plugin

youwenliang published this plugin 3y ago.

v1.2.0 is the latest version.

Native updates are supported within Sketch.app.