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

[ BUG ] Works on Linux but finding place holders fail on Darwin

Open
  • Is something wrong?
#152 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
shell
Domain
cli

Research direction

Start with the gh-md-toc entry point and reproduce the three failing commands on Darwin using the supplied README example. Inspect the placeholder-detection and sed-related paths, then verify that all commands handle README.md correctly on Darwin without regressing Linux behavior.

Written by the indexing model from the issue text.

Description

./gh-md-toc --insert --no-backup --hide-footer --skip-header README.md
./gh-md-toc --no-backup --hide-footer --skip-header README.md
./gh-md-toc --hide-footer --skip-header README.md

The above commands all work on Linux but not Mac.

➜ cat README.md
My readme: https://github.com/sourcenetwork/defradb/blob/c1b612ea28b866093da2d7d1f473ea9de1072a93/README.md

➜ ./gh-md-toc --insert --no-backup --hide-footer --skip-header README.md

Table of Contents
=================

   * [Table of Contents](#table-of-contents)
   * [Install](#install)
   * [Key Management](#key-management)
   * [Start](#start)
   * [Configuration](#configuration)
   * [External port binding](#external-port-binding)
   * [Add a schema type](#add-a-schema-type)
   * [Create a document](#create-a-document)
   * [Query documents](#query-documents)
   * [Obtain document commits](#obtain-document-commits)
   * [DefraDB Query Language (DQL)](#defradb-query-language-dql)
   * [Peer-to-peer data synchronization](#peer-to-peer-data-synchronization)
   * [Securing the HTTP API with TLS](#securing-the-http-api-with-tls)
   * [Access Control System](#access-control-system)
   * [Supporting CORS](#supporting-cors)
   * [Backing up and restoring](#backing-up-and-restoring)
   * [Community](#community)
   * [Licensing](#licensing)
   * [Contributors](#contributors)
You don't have <!--ts--> or <!--te--> in your file...exiting
make[1]: *** [toc] Error 1
make: *** [docs] Error 2

Moreover, even without the --insert the command fails: ./gh-md-toc --no-backup --hide-footer --skip-header README.md

Table of Contents
=================

   * [Table of Contents](#table-of-contents)
   * [Install](#install)
   * [Test Title](#test-title)
   * [Key Management](#key-management)
   * [Start](#start)
   * [Configuration](#configuration)
   * [External port binding](#external-port-binding)
   * [Add a schema type](#add-a-schema-type)
   * [Create a document](#create-a-document)
   * [Query documents](#query-documents)
   * [Obtain document commits](#obtain-document-commits)
   * [DefraDB Query Language (DQL)](#defradb-query-language-dql)
   * [Peer-to-peer data synchronization](#peer-to-peer-data-synchronization)
   * [Securing the HTTP API with TLS](#securing-the-http-api-with-tls)
   * [Access Control System](#access-control-system)
   * [Supporting CORS](#supporting-cors)
   * [Backing up and restoring](#backing-up-and-restoring)
   * [Community](#community)
   * [Licensing](#licensing)
   * [Contributors](#contributors)
You don't have <!--ts--> or <!--te--> in your file...exiting
make[1]: *** [toc] Error 1
make: *** [docs] Error 2

And lastly also without both --insert and --no-backup flags: ./gh-md-toc --hide-footer --skip-header README.md:

Table of Contents
=================

   * [Table of Contents](#table-of-contents)
   * [Install](#install)
   * [Test Title](#test-title)
   * [Key Management](#key-management)
   * [Start](#start)
   * [Configuration](#configuration)
   * [External port binding](#external-port-binding)
   * [Add a schema type](#add-a-schema-type)
   * [Create a document](#create-a-document)
   * [Query documents](#query-documents)
   * [Obtain document commits](#obtain-document-commits)
   * [DefraDB Query Language (DQL)](#defradb-query-language-dql)
   * [Peer-to-peer data synchronization](#peer-to-peer-data-synchronization)
   * [Securing the HTTP API with TLS](#securing-the-http-api-with-tls)
   * [Access Control System](#access-control-system)
   * [Supporting CORS](#supporting-cors)
   * [Backing up and restoring](#backing-up-and-restoring)
   * [Community](#community)
   * [Licensing](#licensing)
   * [Contributors](#contributors)
You don't have <!--ts--> or <!--te--> in your file...exiting

➜ ./gh-md-toc --version

0.10.0

os:     Darwin
arch:   arm64
kernel: 23.4.0
shell:  GNU bash, version 5.2.26(1)-release (aarch64-apple-darwin23.2.0)
Copyright (C) 2022 Free Software Foundation, Inc.
License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>

This is free software; you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

curl : curl 8.4.0 (x86_64-apple-darwin23.0) libcurl/8.4.0 (SecureTransport) LibreSSL/3.3.6 zlib/1.2.12 nghttp2/1.58.0
wget : not installed
grep : grep (BSD grep, GNU compatible) 2.6.0-FreeBSD
awk  : awk version 20200816
sed  : sed: illegal option -- -
usage: sed script [-Ealnru] [-i extension] [file ...]
        sed [-Ealnu] [-i extension] [-e script] ... [-f script_file] ... [file ...]
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

  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.