Skip to content

[feat] Floating table of contents #386

Description

@SandeepKumarKuanar

Why?

Long Markdown files (like my Computer Science notes with 43+ sections) are hard to navigate without a quick outline. Scrolling is slow, and searching interrupts flow. A floating TOC would let me jump between sections instantly.

What?

I got a good one, I bet you remember, I have asked for that default "home" implement from Notion, last time.
This is a feature request for a floating table of content, it's easy to overdo it, so I am trying to learn some UI design in Figma to give u some initial mockups to work with, but it ain't finished, but here is another brief for it, if u wanna implement it then please go ahead

Image Image

A floating outline/side dial that:

  • Shows all headings (H1, H2, H3, etc.) in the current Markdown file
  • Respects nesting/indentation (hierarchical structure)
  • Always visible but collapsed, like a clock's hands or a tiny strip, expands on hover
  • Overlaps on the content if the size decreases, follows the glassmorphic aesthetic, but visible text.
  • Gets out of the way when not in use (keeps the interface clean)
  • Clicking a heading scrolls to that section
  • Possibly shows a dot or indicator for the current section you're reading (in the mockup)
  • Bottom right corner (like a mini-map)
  • Keyboard shortcut — :Outline
  • Click and drag to reorder, , but at the same time probably overkill for v1
  • May be vim binding enabled, but at the same time probably overkill for v1

On vim

  1. j/k to move up/down the outline
  2. Enter to jump to that section
  3. Escape to dismiss

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions