[FR] Page Outline / Table of Contents sidebar for in-page navigation

Open
#9,133 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
15/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
dart, flutter
Domain
frontend

Research direction

The issue names no files, tests or entry points, so the first step is to find the Flutter editor code that renders document headings and to check with maintainers how a sidebar should fit into the layout. Done would mean a toggleable panel that lists H1-H3 headings with nested indentation, jumps to a section when clicked, and updates while the document is edited. Scroll-based highlighting is optional. Expect this to need design agreement before any code.

Written by the indexing model from the issue text.

Description

Description

I'm requesting a Table of Contents feature similar to Notion's page outline sidebar.

What it does:

  • Automatically scans headings (H1, H2, H3) in the current page
  • Displays them in a collapsible sidebar on the right
  • Clicking any heading scrolls/navigates to that section
  • Updates dynamically as I type

Use case:
When working on long pages (thesis notes, project documentation, learning materials), I need quick navigation between sections without scrolling manually. This is essential for deep work sessions where I'm handling multiple complex topics.

Current workaround:
Manually creating links or using search, which breaks flow and adds friction.

Impact

Who benefits:

  • Students and researchers writing long-form content
  • Developers documenting projects
  • Anyone using AppFlowy as a second brain or knowledge base
  • Users migrating from Notion who expect this standard feature

Why it matters:
Navigation efficiency directly impacts productivity. For pages with 10+ sections, this feature saves significant time and maintains focus during deep work.

Additional Context

Reference: Notion's Table of Contents block and page outline sidebar.

Technical notes:

  • Should parse markdown headings automatically
  • Could be a toggleable sidebar (like Notion's ≡ button)
  • Should support nested headings with indentation
  • Optional: highlight current section based on scroll position

My setup: Self-hosted AppFlowy via Podman, primarily used for academic research

Screenshot From 2026-11-14 01-38-32 Screenshot From 2026-11-14 01-38-25
Dominant language
Dart
Stars
79.1k
Forks
6.3k
Avg merge
17h 29m
Merged PRs (30d)
1

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AppFlowy-IO/AppFlowy

All issues in AppFlowy-IO/AppFlowy

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.