[ BUG ] ":" symbol generates unnecessary hyphen
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 45/100
- Issue type
- Bug
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- markdown, shell
- Domain
- documentation, tooling
Research direction
Start by tracing the heading-to-anchor generation used by the online tool for the reproduced Markdown headings. Compare the generated anchors with the expected single-hyphen output for headings containing a colon, then verify both examples and confirm that unrelated heading conversion still works.
Written by the indexing model from the issue text.
Description
Describe the bug
The online tool doesn't work with headers like this: "# Chapter 1: Introducing to something". Symbol : is replaced with hyphen, but it should be removed altogether as per explanation.
To Reproduce
# Chapter 1: Introducing
# Chapter 2: The Foundations
Generates:
- [Chapter 1: Introducing](#chapter-1--introducing)
- [Chapter 2: The Foundations](#chapter-2--the-foundations)
Expected behavior
No double hyphen between 1-introducing
- [Chapter 1: Introducing](#chapter-1-introducing)
- [Chapter 2: The Foundations](#chapter-2-the-foundations)
Environment (please complete the following information):
Online tool: https://ecotrust-canada.github.io/markdown-toc/
- Dominant language
- Shell
- Stars
- 3.3k
- Forks
- 2.7k
- Avg merge
- 20m
- Merged PRs (30d)
- 7
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ekalinin/github-markdown-toc
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
ekalinin/github-markdown-toc#176 ·
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ekalinin/github-markdown-toc#165 ·
-
[Feature] `--no-code-tag-removal` flag allowing to make removal of backticks in TOC entries optionalOpenenhancement
Difficulty 3/5 1-2 days Newbie friendliness 58/100
ekalinin/github-markdown-toc#153 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 35/100
ekalinin/github-markdown-toc#152 · 1 reaction ·
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 35/100
ekalinin/github-markdown-toc#141 ·
All issues in ekalinin/github-markdown-toc
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
pearu/agent-sandbox#156 ·
Maintainers usually reply within 1 day
-
area/documentation squad/marvin
Difficulty 1/5 Under an hour Newbie friendliness 90/100
rancher/stackstate-product-docs#443 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
getumbrel/umbrel-apps#6142 ·
Maintainers usually reply within 2 days
-
triage/confirmed
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
agentscope-ai/agentscope#3030 ·
Maintainers usually reply within 1 day