docs(readme): refresh outdated examples and versions

[SatvikMishra08]

Fixes #165.

README-only refresh for outdated examples and version pins:

• Align Usage / Auto-insert TOC indent examples with the CLI default (--indent 3, see tests/tests.bats)
• Regenerate the README <!--ts-->…<!--te--> TOC to match current output
• Bump GitHub Actions example pins: actions/checkout@v7, stefanzweifel/git-auto-commit-action@v7
• Update public Docker tag from 0.7.0 to 0.10.0 (matches gh_toc_version / Docker Hub)
• Refresh the Tests section (11 active tests; remote/mixed tests are commented out)
• Update “tested on” notes to current CI (ubuntu-latest)
• Fix Combo URL typo (sitemap.s → sitemap.js)

No feature changes. One small fix in gh-md-toc: --insert now only clears/inserts between the first full-line <!--ts-->/<!--te--> pair, so example markers inside README code blocks are left alone (found while applying review feedback). README headings are unchanged so bats heading assertions stay valid.

[ekalinin]

Thanks for working on this!

This branch is based on 97f764a, and #170-#174 have been merged into master since then, so some of the refreshed sections are already out of date. Also, several example outputs look like they were re-indented by hand instead of regenerated, so they don't match what the tool prints now. Could you rebase onto current master and regenerate each example by running ./gh-md-toc on it?

Details below (line numbers refer to README.md in this PR).

Out of date after rebase

• Tests section (~L385): master now has 17 active tests. fix(remote): keep page markup out of the first TOC entry #170 re-enabled the remote/mixed tests, and there are new ones: "TOC for remote non-english chars", "Error for local file without network access" and two "TOC with depth ..." tests. So "remote/mixed tests are commented out" is no longer true. The hand-maintained list goes stale with every new test, so it might be simpler to just show make test with a short generic summary.
• Local files example (L102): it has two leading blank lines and no <!-- Created by ... --> footer, but master's new --depth example right next to it shows the footer. For a single local file the real output is one blank line, the TOC, a blank line and the footer.

Examples that don't match real output

• Dockerfile.vim (L85, L105-106, L224-225): "Or using Pathogen:" and "Or using Vundle:" are h4 headings, so with the default --indent 3 they get 9 spaces, not 3.
• envirius (L127): the current output also has "Table of Contents", "Export environment into tar archive", "Import environment from tar archive" and the footer. The nodeenv wiki example (L180) has the same problem: the real output also includes edx, HSReplay.net, sailing-channels.com, Galaxy and more.
• Multiple files (L192): aminb/rust-for-c has moved to bandali/rust-for-c. gh_toc_load runs curl without -L, so the redirect isn't followed and the TOC comes out empty. Two of the four pages (primitive_types_and_operators, unique_pointers) return 404 even after the redirect. This example needs different URLs.
• Combo (L228): the URL works now that sitemap.s is fixed, but the output shown isn't what the tool prints for that page. The real output starts with badge markup and has other entries ("Table of Contents", "Generate a one time sitemap from a list of urls", ...). Also, the shell expands ~/projects/..., so the real links contain absolute paths, not ~.
• --insert example (L278):
  • The first run's output doesn't have "Table of contents" or "Auto insert and update TOC", but the grep afterwards shows both in the file.
  • Without --hide-footer, both <!-- Created by ... --> and <!-- Added by ... --> get inserted, but only "Added by" is shown, and its ISO date isn't what $(date) produces.
  • There are 16 lines after <!--ts-->, so grep -A15 doesn't reach <!--te-->.
  • stdout would also include "Found markers".
• docker images (L444): the IMAGE ID column is missing, so "11 minutes ago" is in the IMAGE ID position. For a pulled image, CREATED shows the build date (2024-03-03), not the pull time, and 147MB is the size of the 0.7.0 image.

Examples that fail when copied

• Docker 0.10.0 (L441): the image was built in March 2024 from the 0.10.0 tag and doesn't include the remote-parsing fix from fix(remote): keep page markup out of the first TOC entry #170. Running the documented docker run ... envirius/README.md prints GitHub page markup (<button data-component="Button" ...) as the first entry. The image also doesn't support --depth.
• GitHub Actions (L367): please add permissions: contents: write. git-auto-commit-action needs it to push with GITHUB_TOKEN. Without it, repos where the default token is read-only get a 403 in the commit step.

"Tested on" wording (L20, L411)

CI has a single ubuntu-latest job that runs bats under bash. There's no macOS job, and nothing runs zsh. The old text said macOS High Sierra was tested with release 0.4.9. The new wording drops that qualifier and puts macOS and zsh next to the CI mention. Could you reword it so CI is only mentioned for Ubuntu/bash?

Nit

This repo uses type(scope): subject commit messages. Could you rename the commit and PR title to something like docs(readme): refresh outdated examples and versions?

[SatvikMishra08]

Thanks @ekalinin — addressed your review on a rebase of current master:

• Regenerated STDIN / local / remote / wiki / multi-file / combo / --insert examples with ./gh-md-toc (h4 indent, footers, bandali/rust-for-c URLs, absolute paths in combo, full envirius + Who-Uses-Nodeenv output)
• Simplified Tests to make test + a short note (17 bats cases; no hand-maintained checklist)
• Added permissions: contents: write to the Actions recipe
• Clarified CI is Ubuntu/bash only; kept a lighter “used on macOS” note separate from CI
• Documented that the published 0.10.0 image is from March 2024 and lacks later master fixes / --depth

Happy to tweak further if anything still looks off.

[ekalinin]

Thanks for refreshing the examples! A few things I'd fix before merging:

• The sitemap.js part of the Combo example (README.md:272) is broken. Its H1 on blob/master now has badges, so the first entry gets badge HTML as the link text and a URL like README.mdhttps://camo.... Pinning it to 6bc3eb12, like the tests do, should fix it.
• The Docker example (README.md:488) runs 0.10.0 on envirius blob/master, which is the #166 case, so it prints page HTML. Pinning won't help here, because 0.10.0 prints the same <button ...> entry on the pinned f939d3b URL too. The nodeenv wiki URL from site/index.html works with 0.10.0.
• "currently 17 tests" (README.md:442) is already out of date: master has 22 after #177. I'd just drop the number.
• In Remote files (README.md:143), the text talks about a README without a TOC, but the example runs on blob/master, which already has one, so * [Table of Contents] shows up in the output. The pinned f939d3b URL gives output that matches the text.
• Running --insert on the README itself breaks it (README.md:297-298, 331). The sed range isn't anchored, so it picks up the <!--ts-->/<!--te--> markers inside the code blocks, and the TOC lands in the examples.

[SatvikMishra08]

Hi @ekalinin, just checking in: the rebase on current master with your review points is in. Happy to tweak anything else if needed. Thanks!

[SatvikMishra08]

Thanks @ekalinin! All 5 are addressed in 0cd28f7:

• Combo: sitemap.js pinned to 6bc3eb12, output regenerated
• Docker 0.10.0 example now uses the nodeenv wiki URL
• Dropped the test count
• Remote files now runs on the pinned f939d3b URL, output regenerated (no Table of Contents entry)
• --insert: the clear/insert sed now only touches the first full-line <!--ts-->/<!--te--> pair, so the markers in the README's code blocks are left alone. Running --insert on the README itself now only updates the real TOC.

Happy to move the --insert fix into a separate PR if you'd prefer.

[ekalinin]

Thanks for the update! The examples look good now. A few things before merging:

1. The --insert change introduces two regressions. The new range stops at the first full-line <!--te-->, so it doesn't really skip code blocks. If a code block with only <!--te--> comes before the real markers, nothing is updated but the tool still prints "TOC was added". If a code block shows the <!--ts-->/<!--te--> pair above the real TOC, the new TOC goes into the example and the real one stays stale. Master updates the real TOC in both cases. The README case already happens on master, so it doesn't need to block this PR. Let's take you up on your offer: please drop the gh-md-toc change from this PR and open a separate fix PR with --insert tests, one that skips markers inside code fences instead of relying on the first pair.
2. grep -A20 in the --insert example (README.md:319). It prints 20 lines after <!--ts-->, but the shown block ends 13 lines later at <!--te-->, so unless the markers are at the very end of the file, the real output continues past <!--te-->. -A13 matches the output shown.
3. docker images size (README.md:475). 72MB is the compressed size from Docker Hub. docker images shows the uncompressed size, which is larger (the old README showed 147MB for 0.7.0, which is 71MB on Docker Hub).
4. 0.10.0 note (README.md:481). After merging with master, the README also documents --numbered (#177), which 0.10.0 doesn't support either. Please mention it next to --depth.