showdownjs/showdown

TOML Metadata surrounded by +++

Aberta

#868 aberto em 8 de out. de 2021

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)JavaScript (1.640 forks)batch import
enhancementhelp wantedscope:makeHtml

Métricas do repositório

Stars
 (13.700 estrelas)
Métricas de merge de PR
 (Mesclagem média 15h 21m) (3 fundiu PRs em 30d)

Description

Hugo allows TOML metadata (surrounded by +++) - so it's a popular encoding for metadata in files. It would be great if showdown could support it.

Readme says as of today:

metadata: (boolean) [default false] Enable support for document metadata (defined at the top of the document between ««« and »»» or between --- and ---). (since v.1.8.5)

Guia do colaborador

Direção de pesquisa
Examine o código fonte do showdown, especificamente o arquivo onde a análise de metadados é implementada (provavelmente em src/subParsers/makeHtml.js ou similar). O suporte existente a metadados lida com os delimitadores ` ` e `««« ... »»»`. Para adicionar TOML (`+++`), você precisa modificar o analisador para reconhecer `+++` como um delimitador de metadados válido, seguindo o mesmo padrão. Verifique a função que extrai os metadados (por exemplo, `extractMetadata` ou inline no loop principal de análise). Também confirme que o formato TOML em si não é analisado pelo showdown; a questão é apenas sobre o delimitador, não o conteúdo. Adicione um caso de teste para metadados TOML e certifique se de que os testes existentes passem. Como a issue está inativa, é recomendável comentar na issue para reivindicá la antes de começar o trabalho.
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.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Principalmente claro
Prerequisites
JavaScriptRegular Expressions
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
40