newren/git-filter-repo
在 GitHub 查看Minor minor issue: markdown files may not render correctly out of github
Open
#446 创建于 2023年4月5日
good first issue
仓库指标
- Star
- (6,745 star)
- PR 合并指标
- (平均合并 44天 2小时) (30 天内合并 1 个 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.