Generate table of contents for (long?) notes
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 738
- Forks
- 162
- Avg merge
- 6h 2m
- Merged PRs (30d)
- 35
Description
Is your feature request related to a problem? Please describe.
When I have long notes, I can't see all chapters, and can't get an overview of it.
Describe the solution you'd like
If the note is longer than the viewport (or maybe 2 times the viewport, if you can compute it), provide a menu-button that will drop-down as a table of contents.
It could be on left or right, I let UX engineers do their work :)
If detecting viewport length is too much, that could be a setting : Show Table of Contents in Notes Yes/No. My guess is that people who need it for long notes will not mind seeing them also in short notes.
Describe alternatives you've considered
I could make notes shorter, but that would mean multiply notes, and managing data density at notes level. With only categories, it's a bit of a pain, and for some topics, it does not make sense to split.
Additional context
Example extracted from Wikipedia:
Closed:
Expanded:
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file, test, or entry point is named. Start by locating the notes editor and its Markdown heading or rendering path, then clarify the viewport-versus-setting behavior with maintainers. Done means long notes expose a usable table of contents menu, matching the closed and expanded examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, markdown
- Domain
- frontend
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100