gajus/gitdown

Option to control the TOC text for specific anchors

Open

#26 aperta il 25 gen 2015

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)JavaScript (51 fork)github user discovery
help wanted

Metriche repository

Star
 (450 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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".

Guida contributor

Direzione di ricerca
Analizza la logica corrente di generazione del TOC in gitdown e proponi un'opzione di configurazione per sovrascrivere il testo di visualizzazione dell'ancora, possibilmente tramite frontmatter YAML o un file di mappatura.
Tech stack
javascript
Dominio
tooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60