newren/git-filter-repo

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

Open

#446 opened on 2023年4月5日

GitHub で見る
 (4 comments) (0 reactions) (0 assignees)Python (6,745 stars) (674 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
under 1 hour
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.