newren/git-filter-repo

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

Open

#446 opened on Apr 5, 2023

View on GitHub
 (4 comments) (0 reactions) (0 assignees)Python (6,745 stars) (674 forks)batch import
good first issue

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.

Contributor guide

Tech stack
pythonshell
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Locate all markdown files (e.g., INSTALL.md, README.md) and identify any shell variable references (e.g., $MANDIR, $PREFIX). Wrap each variable with backticks to prevent MathJax interpretation. Check for any maintainer feedback in the issue comments for alternative approaches or specific files to modify.