Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

[BUG] TOC picks up YAML

未关闭
#30 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
45/100
Issue 类型
缺陷
描述清晰度
基本清楚
活跃度
停滞
技术栈
go, markdown
领域
cli, tooling

调研方向

使用顶部包含 YAML 的 .md 文件复现该问题,然后检查工具如何根据该输入构建 TOC。完成标准是 YAML 被排除在 TOC 之外,同时 Markdown 标题仍以正确的层级显示。

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

描述

bug

Describe the bug
When running the tool on a .md file, for some reason, it generates a TOC item for the YAML I have at the top of my file. When I was using the shell script, it didn't pick up the YAML and generate a TOC item.

To Reproduce
Use a .md file with YAML at the top and run the tool. The output shows the YAML code ad depth=1

主要语言
Go
星标
525
派生
90
平均合并
2 天 1 小时
30 天内合并 PR
1

环境准备

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

从这里开始

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

ekalinin/github-markdown-toc.go 的其他 Issue

查看 ekalinin/github-markdown-toc.go 的全部 Issue

相似的 Issue

更多 Go Issue

把新 issue 发到你的邮箱

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