Embed Outline shows the headings of embedded notes in one outline

One outline for a note built from embeds, with each chapter's headings under its embed.

MIT · no telemetry · core features free

A manuscript note beside the outline panel, where each embedded chapter and its headings sit under Part one and Part two.
Open larger
version
1.0.0
released
downloads
1
review
Passed
health
Excellent
license
MIT
platforms
Desktop, Mobile
obsidian
1.13.4 or later

Tested on desktop with Obsidian 1.13.4 and 1.14.4. It uses no desktop-only features.

Directory facts fetched from community.obsidian.md/users/theluckystrike.

About Embed Outline

Writers who keep a book, a thesis or a project page as one overview note that embeds the other notes.

The core Outline lists only the headings of the note itself. When a note is mostly embeds of chapter notes, that outline is almost empty. Embed Outline puts the headings of each embedded note under its embed, in the order you read them.

It also adds callout titles and headings that sit inside list items. The plugin only reads your notes. It never changes one.

The outline of a manuscript note with its embedded chapters, a click into a chapter, then word counts with ProPlay demo

Free features

Embedded notes in the outline

Each embed gets a row with the name of the embedded note, with that note's headings under it. The rows sit under the heading of your note that holds the embed. A section embed shows only that heading and the ones below it.

Jump to any row

Click a heading of your note and the cursor moves to it. Click a heading of an embedded note and the note scrolls to the embed, then to that heading. Hold Ctrl, or Cmd on macOS, and click to open the embedded note in a new tab.

The manuscript scrolled to the heading A letter in the drawer, inside the embedded Chapter 2.
Open larger

Callouts and headings in lists

A callout shows as a row with its title, under the heading it sits in. A heading written inside a list item is a row too, which the core Outline never shows. You can turn both off in the settings.

A research note with three callouts, and an outline that lists each callout title and the list heading Open questions.
Open larger

The free outline opens the embeds of the note itself, and an embed inside an embedded note shows as a locked row.

Pro features

Pro costs $5 a month or $15 one time through GitHub Sponsors. One sponsorship turns on Pro in all 15 plugins.

Nested embeds Pro

Without Pro, an embed inside an embedded note shows as a row with a lock. Pro opens them down to 5 levels. You set the depth in the settings.

The outline with the letter that Chapter 2 embeds opened one level deeper, with its two headings.
Open larger

Word counts Pro

Pro shows the number of words next to each heading and each embed, with the embedded text counted. The top of the panel shows the total for the note. Code, comments, front matter, URLs and callout markers don't count.

The outline with a word count on each row, and 439 words for the whole manuscript at the top.
Open larger

Broken embeds Pro

Pro marks an embed whose note, heading or block ID doesn't exist. It also marks an embed that ends up embedding itself. Without Pro, these embeds are left out of the outline.

The outline with a red row that starts with No such note, under the heading Back matter.
Open larger

Copy as a Markdown list Pro

The copy button puts the outline on the clipboard as a nested list. Each heading becomes a link to the note it comes from, with the word count when counts are on. Paste it into a note for a table of contents with links that work.

A note with the pasted outline as a nested list of links, each with its word count.
Open larger

Set up Embed Outline

needs

  • Obsidian 1.13.4 or later

steps

  1. Turn on the plugin. The outline gets a tab in the right sidebar.

  2. Open a note that embeds other notes.

  3. Select the Embed outline tab, or run the command Open the outline panel.

  4. Click a row to go to it.

Why this exists

A forum request for embedded headings in the Outline has 27 votes and has been open since 2021-07-20. Two related requests, for callout titles and for headings inside lists, have 21 and 18 votes.

How to show headings from embedded notes in the Obsidian outline

How it compares

Core Outline
The core Outline lists only the headings of the note itself, and it never shows headings inside list items. Embed Outline doesn't replace it, so both can be open together.

Questions about Embed Outline

Can the Obsidian outline show headings from embedded notes?

The core Outline lists only the headings of the note itself. Embed Outline adds the headings of each embedded note under its embed. Both panels can be open at the same time.

Does Embed Outline change my notes?

No. Embed Outline only reads your notes, and it never changes a note. The Pro copy puts the outline on the clipboard.

Is Embed Outline slow on a long book?

It reads the open note and the notes it embeds from the app's cache, and nothing else in the vault. It stops at 400 notes and 5,000 rows. So a loop of notes that embed each other can't freeze the app.

How fast does the outline update after an edit?

The outline follows the note that you opened last. It updates about a third of a second after you change that note or a note it embeds.

Network use

Embed Outline makes no network requests until you select Sign in with GitHub in its settings. After sign in, it asks the GitHub API about your sponsorship at most once every 7 days, or when you select Refresh. It sends no note content, file names or other vault data.

Read the full network disclosure

Embed Outline 1.0.0, MIT license

MIT · no telemetry · core features free