Update outdated examples and versions in README
还没有人认领这个 Issue。
评估
- 难度
- 2/5
- 预计耗时
- 1-3 小时
- 新手友好度
- 88/100
- Issue 类型
- 文档
- 描述清晰度
- 描述清楚
- 活跃度
- 活跃
- 技术栈
- docker, github-actions, shell
调研方向
更新 README 中的示例、生成的 TOC、action 和 Docker 版本、测试数量文本、tested-on 说明以及 Combo URL。首先阅读相关的 README 部分，并比较 tests/tests.bats 中的缩进和测试预期。保持标题不变，然后运行测试，以确认 README 标题列表和更新后的文档正确无误。
由索引模型根据 Issue 内容生成。
描述
README contains several outdated examples and versions.
Outdated items
- Usage and "Auto insert and update TOC" examples show TOC output in an old
format (2 and 8 space indents). The current default is--indent 3: top-level
entries have no indent, nested ones use 3, 6, ... spaces (seetests/tests.bats). - README's own TOC between
<!--ts-->and<!--te-->was generated by an older
version: its indentation differs from the current output. - "TOC generation with Github Actions" uses
actions/checkout@v2and
stefanzweifel/git-auto-commit-action@v4. The latest releases arev7.0.1and
v7.2.0. - Docker / Public pulls
evkalinin/gh-md-toc:0.7.0. Docker Hub has tags up to
0.10.0, which matchesgh_toc_version. - Tests shows an old run with 6 tests, including "TOC for remote README.md" and
"TOC for mixed README.md (remote/local)", which are commented out now. The suite
has 11 tests. - "Tested on" statements: "macOS High Sierra (gh-md-toc release 0.4.9)" in the
intro and "Ubuntu 14.04/14.10 in bash/zsh" in Dependency. CI runs on
ubuntu-latest. - Combo example has a typo in the URL:
sitemap.sinstead ofsitemap.js.
Notes
tests/tests.batsasserts README's heading list, so headings should stay
unchanged.
- 主要语言
- Shell
- 星标
- 3.3k
- 派生
- 2.7k
- 平均合并
- 20 分钟
- 30 天内合并 PR
- 7
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 没有贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
ekalinin/github-markdown-toc 的其他 Issue
-
难度 1/5 1-3 小时 新手友好度 78/100
ekalinin/github-markdown-toc#176 ·
-
[Feature] `--no-code-tag-removal` flag allowing to make removal of backticks in TOC entries optional未关闭enhancement
难度 3/5 1-2 天 新手友好度 58/100
ekalinin/github-markdown-toc#153 ·
-
难度 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
-
area/documentation squad/marvin
难度 1/5 1 小时以内 新手友好度 90/100
rancher/stackstate-product-docs#443 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 84/100
getumbrel/umbrel-apps#6142 ·
维护者通常 2 天内回复
-
triage/confirmed
难度 2/5 1-3 小时 新手友好度 78/100
agentscope-ai/agentscope#3030 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 78/100
WingedGuardian/GENesis-AGI#2599 ·
维护者通常 1 天内回复
-
bug good first issue
难度 2/5 1-3 小时 新手友好度 88/100
petry-projects/.github-private#1981 · 1 条评论 ·
维护者通常 1 天内回复