newren/git-filter-repo

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

Open

#446 建立於 2023年4月5日

在 GitHub 查看
 (4 留言) (0 反應) (0 負責人)Python (6,745 star) (674 fork)batch import
good first issue

描述

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.

貢獻者指南

技術棧
pythonshell
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
under 1 hour
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
無
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
90
研究方向
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.