newren/git-filter-repo

Minor minor issue: markdown files may not render correctly out of github

Open

#446 aberto em 5 de abr. de 2023

Ver no GitHub
 (4 comments) (0 reactions) (0 assignees)Python (674 forks)batch import
good first issue

Métricas do repositório

Stars
 (6.745 stars)
Métricas de merge de PR
 (Mesclagem média 44d 2h) (1 fundiu PR em 30d)

Description

Markdown files distributed with this project (e.g. INSTALL.md) may not render correctly when displayed out of github (or better, with a markdown viewer that is not the github one).

Specifically, when paths including shell variables are used (e.g. $MANDIR/man1/) the string is not guarded by back quotes. As such all viewers supporting MathJax will interpret the $ as the beginning of a mathematical expression and misrender all the following text.

To avoid this problem, I suggest guarding all paths and shell variables in markdown files withing backquotes.

Guia do colaborador

Direção de pesquisa
Identifique todos os arquivos Markdown no repositório (por exemplo, INSTALL.md, README.md) e localize quaisquer cifrões ($) usados para variáveis de shell ou caminhos. Envolva cada ocorrência com crases (`) para evitar interpretação incorreta pelo MathJax e outros renderizadores Markdown.
Pilha de tecnologia
python
Domain
documentationdeveloper experience
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
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
GitMarkdown
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
85