[Feature] `--no-code-tag-removal` flag allowing to make removal of backticks in TOC entries optional
还没有人认领这个 Issue。
评估
调研方向
Start at the gh-md-toc logic around line 280 referenced in the issue, then trace how CLI flags are parsed and how generated TOC entries are formatted. Add the optional flag so code tags remain when requested, while preserving the current default behavior; verify the output for a heading such as # Headline``.
由索引模型根据 Issue 内容生成。
描述
Is your feature request related to a problem? Please describe.
CI in one of my projects started failing, because the generated TOC entries did not contain backticks. I.e. a headline:
# `Headline`
becomes a TOC entry
* [Headline](#headline)
Note the missing backticks ` in the generated TOC entry. My linter didn't like that and started failing CI.
Describe the solution you'd like
I'd like to have the option to generate a TOC entry:
* [`Headline`](#headline)
with the backticks present.
For this I propose a new CLI flag --no-code-tag-removal that when present disables the current logic removing the generated <code> and </code> tags and instead replaces them with a backtick again.
Describe alternatives you've considered
-
Reverting parts of 1056956, namely this line:
While I believe this was a rather arbitrary change of logic in response to #13, it would still be a breaking change just to revert it. There might be users that want backticks to be removed from the TOC.
-
Adding a flag
--remove-code-tags.While I find
--remove-code-tagsto be a better name than--no-code-tag-removal, it would reverse the logic of code tag removal and become a breaking change again, just like the first considered alternative. I.e. now the default is that backticks are removed. The proposed--no-code-tag-removalflag would change that, add backticks to the generated TOC entries again.--remove-code-tagswould be the opposite, make code tags in the output the default (breaking change), allowing the user to opt out of this.
- 主要语言
- Shell
- 星标
- 3.3k
- 派生
- 2.7k
- 平均合并
- 7 分钟
- 30 天内合并 PR
- 3
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
ekalinin/github-markdown-toc 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 84/100
ekalinin/github-markdown-toc#167 ·
-
documentation
难度 2/5 1-3 小时 新手友好度 88/100
ekalinin/github-markdown-toc#165 ·
-
难度 3/5 1-2 天 新手友好度 35/100
ekalinin/github-markdown-toc#152 · 1 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 35/100
ekalinin/github-markdown-toc#141 ·
-
难度 4/5 3-5 天 新手友好度 15/100
ekalinin/github-markdown-toc#139 ·
查看 ekalinin/github-markdown-toc 的全部 Issue
相似的 Issue
-
package-update
难度 2/5 1-3 小时 新手友好度 68/100
oSoWoSo/vOid_Community_repOsitory#203 · 1 条评论 ·
维护者通常 1 天内回复
-
[Bug] v-quick-install-app install crashes with ValueError if no supported PHP version is installed未关闭
难度 2/5 1-3 小时 新手友好度 84/100
维护者通常 1 天内回复
-
chore
难度 2/5 1-3 小时 新手友好度 84/100
alunduil/alunduil-chezmoi#809 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
维护者通常 1 天内回复
-
type: bug
难度 2/5 1-3 小时 新手友好度 67/100
catppuccin/kde#152 ·