Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

[Feature] `--no-code-tag-removal` flag allowing to make removal of backticks in TOC entries optional

Open
  • Is something wrong?
#153 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
58/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
markdown, shell
Domain
cli, content

Research direction

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``.

Written by the indexing model from the issue text.

Description

enhancement

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

  1. Reverting parts of 1056956, namely this line:

    https://github.com/ekalinin/github-markdown-toc/blob/0ccf70d0f49b61895f64bca86793ff8cdb88ad51/gh-md-toc#L280

    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.

  2. Adding a flag --remove-code-tags.

    While I find --remove-code-tags to 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-removal flag would change that, add backticks to the generated TOC entries again. --remove-code-tags would be the opposite, make code tags in the output the default (breaking change), allowing the user to opt out of this.

Dominant language
Shell
Stars
3.3k
Forks
2.7k
Avg merge
7m
Merged PRs (30d)
3

Getting set up

  • Ships a Dockerfile or Docker Compose file
  • No pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ekalinin/github-markdown-toc

All issues in ekalinin/github-markdown-toc

Similar issues

More Shell/Bash issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.