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

TOC not generated correctly

Open
  • Is something wrong?
#78 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
38/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
shell
Domain
cli

Research direction

Start by reproducing the command against the linked CreatingRationalMusicLibrary2.md file and compare gh-md-toc output with GitHub's rendered anchors. Trace the heading and anchor handling in gh-md-toc; done means the generated TOC renders correctly on the linked GitHub page.

Written by the indexing model from the issue text.

Description

bug

I'm not getting the expected results:

Here's what I've done:

  1. curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc
  2. chmod a+x gh-md-toc
  3. ./gh-md-toc /Users/seamus/Documents/GitHub/PiFormulae/CreatingRationalMusicLibrary2.md > new-with-toc.txt
  4. cat new-with-toc.txt

Table of Contents

  * [Create a Rational and Portable File Server for Your Music Library](#create-a-rational-and-portable-file-server-for-your-music-library)
        * [0. Objective](#0-objective)
        * [1. Select the USB storage media](#1-select-the-usb-storage-media)
        * [2. Create and format a partition](#2-create-and-format-a-partition)
        * [2. Mounting a network storage device:](#2-mounting-a-network-storage-device)
        * [3. Copy/Sync Music repositories](#3-copysync-music-repositories)
        * [3.ALT Copy Music repositories using install](#3alt-copy-music-repositories-using-install)
        * [4. Serve!](#4-serve)
        * [Linux vs. Samba <em><strong>permissions</strong></em>](#linux-vs-samba-permissions)
        * [Samba profile for single user pi](#samba-profile-for-single-user-pi)
        * [Samba profile for read-only guest access, write access for user pi](#samba-profile-for-read-only-guest-access-write-access-for-user-pi)

Created by gh-md-toc

After a select+C&P into my .md file & uploading, this doesn't render properly on my github page:

(https://github.com/seamusdemora/PiFormulae/blob/master/CreatingRationalMusicLibrary2.md)

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.