gajus/gitdown

Option to control the TOC text for specific anchors

Open

#26 geöffnet am 25. Jan. 2015

Auf GitHub ansehen
 (2 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)JavaScript (51 Forks)github user discovery
help wanted

Repository-Metriken

Stars
 (450 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Untersuche die aktuelle TOC Generierungslogik in gitdown und schlage eine Konfigurationsoption vor, um den Anzeigetext von Ankern zu überschreiben, möglicherweise über YAML Frontmatter oder eine Mapping Datei.
Tech Stack
javascript
Domain
tooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Keine
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
60