gajus/gitdown

Option to control the TOC text for specific anchors

Open

#26 opened on Jan 25, 2015

View on GitHub
 (2 comments) (0 reactions) (0 assignees)JavaScript (51 forks)github user discovery
help wanted

Repository metrics

Stars
 (450 stars)
PR merge metrics
 (PR metrics pending)

Description

Sometimes I don't want to display the full heading of a section in the table of contents. Is there or could there be an option to override the heading display?

Example: currently in the Reductio README (https://github.com/esjewett/reductio), one heading is "reductio.avg(boolean|value)". I would like this to be the heading, but in the TOC I'd like to display only "avg".

Contributor guide

Research direction
Investigate the current TOC generation logic in gitdown and propose a configuration option to override anchor display text, possibly via a YAML front matter or a mapping file.
Tech stack
javascript
Domain
tooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60