gajus/gitdown

Option to control the TOC text for specific anchors

Open

#26 ouverte le 25 janv. 2015

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)JavaScript (51 forks)github user discovery
help wanted

Métriques du dépôt

Stars
 (450 stars)
Métriques de merge PR
 (Métriques PR en attente)

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

Guide contributeur

Direction de recherche
Examinez la logique actuelle de génération de la table des matières dans gitdown et proposez une option de configuration pour remplacer le texte d'affichage d'une ancre, éventuellement via un frontmatter YAML ou un fichier de correspondance.
Stack technique
javascript
Domaine
tooling
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
60