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

Update outdated examples and versions in README

Open Beginner friendly
  • Is something wrong?
#165 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

@SatvikMishra08 is already working on this.

Since Sep 27, 2026.

  • #169 by @SatvikMishra08 — open

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
88/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
docker, github-actions, shell
Domain
documentation

Research direction

Update the examples, generated TOC, action and Docker versions, test-count text, tested-on statements, and Combo URL in README. First read the relevant README sections and compare the indentation and test expectations in tests/tests.bats. Keep headings unchanged, then run the tests to confirm the README heading list and updated documentation are correct.

Written by the indexing model from the issue text.

Description

documentation

README contains several outdated examples and versions.

Outdated items

  • Usage and "Auto insert and update TOC" examples show TOC output in an old
    format (2 and 8 space indents). The current default is --indent 3: top-level
    entries have no indent, nested ones use 3, 6, ... spaces (see tests/tests.bats).
  • README's own TOC between <!--ts--> and <!--te--> was generated by an older
    version: its indentation differs from the current output.
  • "TOC generation with Github Actions" uses actions/checkout@v2 and
    stefanzweifel/git-auto-commit-action@v4. The latest releases are v7.0.1 and
    v7.2.0.
  • Docker / Public pulls evkalinin/gh-md-toc:0.7.0. Docker Hub has tags up to
    0.10.0, which matches gh_toc_version.
  • Tests shows an old run with 6 tests, including "TOC for remote README.md" and
    "TOC for mixed README.md (remote/local)", which are commented out now. The suite
    has 11 tests.
  • "Tested on" statements: "macOS High Sierra (gh-md-toc release 0.4.9)" in the
    intro and "Ubuntu 14.04/14.10 in bash/zsh" in Dependency. CI runs on
    ubuntu-latest.
  • Combo example has a typo in the URL: sitemap.s instead of sitemap.js.

Notes

  • tests/tests.bats asserts README's heading list, so headings should stay
    unchanged.
Dominant language
Shell
Stars
3.3k
Forks
2.7k
Avg merge
19m
Merged PRs (30d)
8

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.