markdownlint update resulting in errors listed for Command Line Cheat Sheet page

未关闭 适合新手
#67 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
68/100
Issue 类型
文档
描述清晰度
基本清楚
活跃度
冷清
技术栈
markdown
领域
documentation

调研方向

先查看 docs/wiki-guide/Command-Line-Cheat-Sheet.md 和 .markdownlint.json,然后运行 markdownlint -c .markdownlint.json -f docs/wiki-guide 以重现 MD060 错误。将受影响的表格与更新后的规则行为进行比较,并确定应更改页面还是 lint 配置;当预期的解决方案已记录下来且该命令不再报告这些错误时,即表示完成。

由索引模型根据 Issue 内容生成。

描述

bug

The markdownlint behavior for MD060 was updated. Looks like it's changes from two commits:

When I run

 markdownlint -c .markdownlint.json -f docs/wiki-guide

I get repeated warnings (multiple lines) for the Command Line Cheat Sheet:

docs/wiki-guide/Command-Line-Cheat-Sheet.md:13:14 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:14:8 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:15:10 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:15:1 error MD060/table-column-style Table column style [Table pipe is missing space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:16:9 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
...
docs/wiki-guide/Command-Line-Cheat-Sheet.md:35:32 error MD060/table-column-style Table column style [Table pipe has extra space to the left for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:35:32 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:36:29 error MD060/table-column-style Table column style [Table pipe has extra space to the left for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:36:29 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:37:30 error MD060/table-column-style Table column style [Table pipe has extra space to the left for style "compact"]
docs/wiki-guide/Command-Line-Cheat-Sheet.md:37:30 error MD060/table-column-style Table column style [Table pipe has extra space to the right for style "compact"]

We should investigate the change and update as needed (the page, the markdownlintignore, etc.). The tables in the page are certainly not cleanly aligned. Autofix is an open issue.

主要语言
Python
星标
1
派生
1
平均合并
6 天 1 小时
30 天内合并 PR
1

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

Imageomics/Collaborative-distributed-science-guide 的其他 Issue

查看 Imageomics/Collaborative-distributed-science-guide 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。