newren/git-filter-repo

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

Open

#446 aperta il 5 apr 2023

Vedi su GitHub
 (4 commenti) (0 reazioni) (0 assegnatari)Python (674 fork)batch import
good first issue

Metriche repository

Star
 (6745 star)
Metriche merge PR
 (Merge medio 44g 2h) (1 PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Identifica tutti i file Markdown nel repository (ad es. INSTALL.md, README.md) e individua i segni di dollaro ($) utilizzati per variabili di shell o percorsi. Racchiudi ogni occorrenza con backtick (`) per evitare interpretazioni errate da parte di MathJax e altri renderer Markdown.
Tech stack
python
Dominio
documentationdeveloper experience
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
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
GitMarkdown
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85