Pop plugin · Convert

Markdown Table of Contents

Create a table of contents from the headings in the selected Markdown, with links to each heading (GitHub-style anchors).

Works with Selected textFree

How to use it

Select something, hold the right mouse button, swipe. The animation plays the steps one after another; click a step to see it again.

  1. Select a Markdown document
  2. Hold the right mouse buttonAbout a quarter of a second. A short click still opens the usual menu.
  3. Swipe to “Markdown Table of Contents” and let goIt sits on the ring where you put it, and it’s always in All Actions.
  4. A linked table of contents
  5. Copy it into the READMEThe links jump to each heading, on GitHub too.

What it does

Select a Markdown document and get a table of contents from its headings, indented by level.

Each entry links to its heading, with the anchor written the way GitHub writes it; headings with the same name get numbers.

A # inside a code block isn’t taken for a heading.

Install it

Plugins aren’t part of the Pop download. Install this one when you need it.

1From Settings

In Pop’s Settings › Actions, find “Markdown Table of Contents” under Plugins at the top and click Install. It downloads from Pop’s GitHub release in a few seconds and works right away, without a restart.

2Or from the ring

Open All Actions on the ring and search for “Markdown Table of Contents”. Plugins that aren’t installed are listed after your actions: click it to install, and it runs right away if it can handle what you selected.

3Then use it your way

Put it on the ring in Settings › Ring, give it a shortcut, or run it from Shortcuts and scripts with its link:

pop://run?plugin=markdownTOC

Uninstall it from the same list when you no longer need it: the plugin and its settings are deleted. After Pop updates, installed plugins are updated with it, and with iCloud sync on, what you install syncs to your other Macs.