commonmark / commonmark/commonmark-java

Table of Contents support

Open
#189 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement help wanted
Dominant language
Java
Stars
2.7k
Forks
336
PR merge metrics
No merged PRs in 30d

Description

Would be great to have [TOC] support to automatically list out the contents of the different headers. Probably would be a good candidate for another extension

Contributor guide

Open the 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.

Research direction

No files or tests are named. Start by reviewing the library's parser and renderer extension approach, then define how [TOC] should identify and list headers; done means the extension generates a table of contents from the document's headings.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, markdown
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.