NotePlan / NotePlan/plugins

Feature Request: Table of Contents

Open
#518 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
204
Forks
82
Avg merge
22h 27m
Merged PRs (30d)
3

Description

We have had multiple requests for a "Table of Contents" feature, which would take the headings within a Note and create a table of contents from them.

There is a discussion regarding implementation, which can be found in the Plugins Discord with a note from Eduard here:

https://discord.com/channels/763107030223290449/784376250771832843/1197302125596782642

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Start by reviewing the Plugins Discord discussion linked in the issue, especially Eduard's note, to understand the proposed implementation. The requested outcome is a table of contents generated from a Note's headings, but the issue names no repository files, entry points, or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
content
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.