newren/git-filter-repo
GitHub で見るMinor minor issue: markdown files may not render correctly out of github
Open
#446 opened on 2023年4月5日
good first issue
Repository metrics
- Stars
- (6,745 stars)
- PR merge metrics
- (平均マージ 44d 2h) (30d で 1 merged PR)
説明
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.