commonmark / commonmark/cmark

Please add Table of Contents function

Open
#235 1 comment 13 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
2k
Forks
691
Avg merge
1d 16h
Merged PRs (30d)
1

Description

Please would it be possible to add a Table of Contents option (like --toc in pandoc) to generate a TOC at the top of the html document converted from markdown?

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 tracing cmark’s command-line option handling for a pandoc-like --toc option and the HTML conversion path for Markdown input. Define the expected placement and contents of the generated table of contents, then verify that invoking the option produces a TOC at the top of the HTML document without it appearing by default.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.