gajus/gitdown

Option to control the TOC text for specific anchors

Open

#26 aberto em 25 de jan. de 2015

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

Métricas do repositório

Stars
 (450 stars)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Investigue a lógica atual de geração de TOC no gitdown e proponha uma opção de configuração para substituir o texto de exibição da âncora, possivelmente via frontmatter YAML ou um arquivo de mapeamento.
Pilha de tecnologia
javascript
Domain
tooling
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
None
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60