From d11a237186e232f2c2bf90f252c1430a2abcc3f9 Mon Sep 17 00:00:00 2001 From: SatvikMishra08 Date: Sun, 27 Sep 2026 11:39:36 +0000 Subject: [PATCH] docs: refresh outdated README examples and versions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Fixes #165. - Align TOC indent examples with default --indent 3 - Regenerate README … TOC - Bump Actions pins to checkout@v7 and git-auto-commit-action@v7 - Update Docker Hub tag to 0.10.0 - Refresh tests blurb (11 tests) and tested-on notes - Fix Combo URL typo (sitemap.s → sitemap.js) --- README.md | 225 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 115 insertions(+), 110 deletions(-) diff --git a/README.md b/README.md index 6231976..b8f07f9 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ gh-md-toc is able to process: * local files (markdown files in local file system) * remote files (html files on github.com) -gh-md-toc tested on Ubuntu, and macOS High Sierra (gh-md-toc release 0.4.9). If you want it on Windows, you +gh-md-toc is tested on Ubuntu (CI uses `ubuntu-latest`) and macOS. If you want it on Windows, you better to use a golang based implementation: * [github-markdown-toc.go](https://github.com/ekalinin/github-markdown-toc.go) @@ -29,21 +29,21 @@ Table of contents ================= - * [Installation](#installation) - * [Usage](#usage) - * [STDIN](#stdin) - * [Local files](#local-files) - * [Remote files](#remote-files) - * [Multiple files](#multiple-files) - * [Combo](#combo) - * [Auto insert and update TOC](#auto-insert-and-update-toc) - * [GitHub token](#github-token) - * [TOC generation with Github Actions](#toc-generation-with-github-actions) - * [Tests](#tests) - * [Dependency](#dependency) - * [Docker](#docker) - * [Local](#local) - * [Public](#public) +* [Installation](#installation) +* [Usage](#usage) + * [STDIN](#stdin) + * [Local files](#local-files) + * [Remote files](#remote-files) + * [Multiple files](#multiple-files) + * [Combo](#combo) + * [Auto insert and update TOC](#auto-insert-and-update-toc) + * [GitHub token](#github-token) + * [TOC generation with Github Actions](#toc-generation-with-github-actions) +* [Tests](#tests) +* [Dependency](#dependency) +* [Docker](#docker) + * [Local](#local) + * [Public](#public) @@ -79,12 +79,12 @@ Here's an example of TOC creating for markdown from STDIN: ```bash ➥ cat ~/projects/Dockerfile.vim/README.md | ./gh-md-toc - - * [Dockerfile.vim](#dockerfilevim) - * [Screenshot](#screenshot) - * [Installation](#installation) - * [OR using Pathogen:](#or-using-pathogen) - * [OR using Vundle:](#or-using-vundle) - * [License](#license) +* [Dockerfile.vim](#dockerfilevim) +* [Screenshot](#screenshot) +* [Installation](#installation) + * [OR using Pathogen:](#or-using-pathogen) + * [OR using Vundle:](#or-using-vundle) +* [License](#license) ``` Local files @@ -99,12 +99,12 @@ Here's an example of TOC creating for a local README.md: Table of Contents ================= - * [Dockerfile.vim](#dockerfilevim) - * [Screenshot](#screenshot) - * [Installation](#installation) - * [OR using Pathogen:](#or-using-pathogen) - * [OR using Vundle:](#or-using-vundle) - * [License](#license) +* [Dockerfile.vim](#dockerfilevim) +* [Screenshot](#screenshot) +* [Installation](#installation) + * [OR using Pathogen:](#or-using-pathogen) + * [OR using Vundle:](#or-using-vundle) +* [License](#license) ``` Remote files @@ -124,40 +124,40 @@ There is nothing easier: Table of Contents ================= - * [envirius](#envirius) - * [Idea](#idea) - * [Features](#features) - * [Installation](#installation) - * [Uninstallation](#uninstallation) - * [Available plugins](#available-plugins) - * [Usage](#usage) - * [Check available plugins](#check-available-plugins) - * [Check available versions for each plugin](#check-available-versions-for-each-plugin) - * [Create an environment](#create-an-environment) - * [Activate/deactivate environment](#activatedeactivate-environment) +* [envirius](#envirius) + * [Idea](#idea) + * [Features](#features) +* [Installation](#installation) +* [Uninstallation](#uninstallation) +* [Available plugins](#available-plugins) +* [Usage](#usage) + * [Check available plugins](#check-available-plugins) + * [Check available versions for each plugin](#check-available-versions-for-each-plugin) + * [Create an environment](#create-an-environment) + * [Activate/deactivate environment](#activatedeactivate-environment) * [Activating in a new shell](#activating-in-a-new-shell) * [Activating in the same shell](#activating-in-the-same-shell) - * [Get list of environments](#get-list-of-environments) - * [Get current activated environment](#get-current-activated-environment) - * [Do something in environment without enabling it](#do-something-in-environment-without-enabling-it) - * [Get help](#get-help) - * [Get help for a command](#get-help-for-a-command) - * [How to add a plugin?](#how-to-add-a-plugin) - * [Mandatory elements](#mandatory-elements) + * [Get list of environments](#get-list-of-environments) + * [Get current activated environment](#get-current-activated-environment) + * [Do something in environment without enabling it](#do-something-in-environment-without-enabling-it) + * [Get help](#get-help) + * [Get help for a command](#get-help-for-a-command) +* [How to add a plugin?](#how-to-add-a-plugin) + * [Mandatory elements](#mandatory-elements) * [plug_list_versions](#plug_list_versions) * [plug_url_for_download](#plug_url_for_download) * [plug_build](#plug_build) - * [Optional elements](#optional-elements) + * [Optional elements](#optional-elements) * [Variables](#variables) * [Functions](#functions) - * [Examples](#examples) - * [Example of the usage](#example-of-the-usage) - * [Dependencies](#dependencies) - * [Supported OS](#supported-os) - * [Tests](#tests) - * [Version History](#version-history) - * [License](#license) - * [README in another language](#readme-in-another-language) + * [Examples](#examples) +* [Example of the usage](#example-of-the-usage) +* [Dependencies](#dependencies) +* [Supported OS](#supported-os) +* [Tests](#tests) +* [Version History](#version-history) +* [License](#license) +* [README in another language](#readme-in-another-language) ``` That's all! Now all you need — is copy/paste result from console into original @@ -177,9 +177,9 @@ Moreover, it's able to work with GitHub's wiki pages: Table of Contents ================= - * [Who Uses Nodeenv?](#who-uses-nodeenv) - * [OpenStack](#openstack) - * [pre-commit.com](#pre-commitcom) +* [Who Uses Nodeenv?](#who-uses-nodeenv) + * [OpenStack](#openstack) + * [pre-commit.com](#pre-commitcom) ``` Multiple files @@ -194,18 +194,18 @@ It supports multiple files as well: https://github.com/aminb/rust-for-c/blob/master/primitive_types_and_operators/README.md \ https://github.com/aminb/rust-for-c/blob/master/unique_pointers/README.md - * [Hello world](https://github.com/aminb/rust-for-c/blob/master/hello_world/README.md#hello-world) +* [Hello world](https://github.com/aminb/rust-for-c/blob/master/hello_world/README.md#hello-world) - * [Control Flow](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#control-flow) - * [If](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#if) - * [Loops](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#loops) - * [For loops](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#for-loops) - * [Switch/Match](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#switchmatch) - * [Method call](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#method-call) +* [Control Flow](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#control-flow) + * [If](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#if) + * [Loops](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#loops) + * [For loops](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#for-loops) + * [Switch/Match](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#switchmatch) + * [Method call](https://github.com/aminb/rust-for-c/blob/master/control_flow/README.md#method-call) - * [Primitive Types and Operators](https://github.com/aminb/rust-for-c/blob/master/primitive_types_and_operators/README.md#primitive-types-and-operators) +* [Primitive Types and Operators](https://github.com/aminb/rust-for-c/blob/master/primitive_types_and_operators/README.md#primitive-types-and-operators) - * [Unique Pointers](https://github.com/aminb/rust-for-c/blob/master/unique_pointers/README.md#unique-pointers) +* [Unique Pointers](https://github.com/aminb/rust-for-c/blob/master/unique_pointers/README.md#unique-pointers) ``` Combo @@ -216,19 +216,19 @@ You can easily combine both ways: ```bash ➥ ./gh-md-toc \ ~/projects/Dockerfile.vim/README.md \ - https://github.com/ekalinin/sitemap.s/blob/master/README.md + https://github.com/ekalinin/sitemap.js/blob/master/README.md - * [Dockerfile.vim](~/projects/Dockerfile.vim/README.md#dockerfilevim) - * [Screenshot](~/projects/Dockerfile.vim/README.md#screenshot) - * [Installation](~/projects/Dockerfile.vim/README.md#installation) - * [OR using Pathogen:](~/projects/Dockerfile.vim/README.md#or-using-pathogen) - * [OR using Vundle:](~/projects/Dockerfile.vim/README.md#or-using-vundle) - * [License](~/projects/Dockerfile.vim/README.md#license) +* [Dockerfile.vim](~/projects/Dockerfile.vim/README.md#dockerfilevim) +* [Screenshot](~/projects/Dockerfile.vim/README.md#screenshot) +* [Installation](~/projects/Dockerfile.vim/README.md#installation) + * [OR using Pathogen:](~/projects/Dockerfile.vim/README.md#or-using-pathogen) + * [OR using Vundle:](~/projects/Dockerfile.vim/README.md#or-using-vundle) +* [License](~/projects/Dockerfile.vim/README.md#license) - * [sitemap.js](https://github.com/ekalinin/sitemap.js/blob/master/README.md#sitemapjs) - * [Installation](https://github.com/ekalinin/sitemap.js/blob/master/README.md#installation) - * [Usage](https://github.com/ekalinin/sitemap.js/blob/master/README.md#usage) - * [License](https://github.com/ekalinin/sitemap.js/blob/master/README.md#license) +* [sitemap.js](https://github.com/ekalinin/sitemap.js/blob/master/README.md#sitemapjs) + * [Installation](https://github.com/ekalinin/sitemap.js/blob/master/README.md#installation) + * [Usage](https://github.com/ekalinin/sitemap.js/blob/master/README.md#usage) + * [License](https://github.com/ekalinin/sitemap.js/blob/master/README.md#license) ``` @@ -251,16 +251,16 @@ $ ./gh-md-toc --insert README.test.md Table of Contents ================= - * [gh-md-toc](#gh-md-toc) - * [Installation](#installation) - * [Usage](#usage) - * [STDIN](#stdin) - * [Local files](#local-files) - * [Remote files](#remote-files) - * [Multiple files](#multiple-files) - * [Combo](#combo) - * [Tests](#tests) - * [Dependency](#dependency) +* [gh-md-toc](#gh-md-toc) +* [Installation](#installation) +* [Usage](#usage) + * [STDIN](#stdin) + * [Local files](#local-files) + * [Remote files](#remote-files) + * [Multiple files](#multiple-files) + * [Combo](#combo) +* [Tests](#tests) +* [Dependency](#dependency) !! TOC was added into: 'README.test.md' !! Origin version of the file: 'README.test.md.orig.2018-02-04_192655' @@ -275,18 +275,18 @@ Now check the same file: ```bash ➜ grep -A15 "<\!\-\-ts" README.test.md - * [gh-md-toc](#gh-md-toc) - * [Table of contents](#table-of-contents) - * [Installation](#installation) - * [Usage](#usage) - * [STDIN](#stdin) - * [Local files](#local-files) - * [Remote files](#remote-files) - * [Multiple files](#multiple-files) - * [Combo](#combo) - * [Auto insert and update TOC](#auto-insert-and-update-toc) - * [Tests](#tests) - * [Dependency](#dependency) +* [gh-md-toc](#gh-md-toc) +* [Table of contents](#table-of-contents) +* [Installation](#installation) +* [Usage](#usage) + * [STDIN](#stdin) + * [Local files](#local-files) + * [Remote files](#remote-files) + * [Multiple files](#multiple-files) + * [Combo](#combo) + * [Auto insert and update TOC](#auto-insert-and-update-toc) +* [Tests](#tests) +* [Dependency](#dependency) @@ -358,13 +358,13 @@ jobs: runs-on: ubuntu-latest timeout-minutes: 5 steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v7 - run: | curl https://raw.githubusercontent.com/ekalinin/github-markdown-toc/master/gh-md-toc -o gh-md-toc chmod a+x gh-md-toc ./gh-md-toc --insert --no-backup --hide-footer foo.md rm gh-md-toc - - uses: stefanzweifel/git-auto-commit-action@v4 + - uses: stefanzweifel/git-auto-commit-action@v7 with: commit_message: Auto update markdown TOC ``` @@ -382,16 +382,21 @@ Useful articles: How to run tests: ```bash -➥ make test +➥ make test ✓ TOC for local README.md - ✓ TOC for remote README.md - ✓ TOC for mixed README.md (remote/local) + ✓ TOC for local README.md with skip headers ✓ TOC for markdown from stdin ✓ --help + ✓ no arguments ✓ --version + ✓ TOC for non-english chars, #6, #10 + ✓ TOC for text with backquote, #13 + ✓ TOC for text with plus signs, #100 + ✓ Toc for file path with space, #136 + ✓ Toc for setext heading with formatting, #145 -6 tests, 0 failures +11 tests, 0 failures ``` Dependency @@ -403,7 +408,7 @@ Dependency * sed * bats (for unit tests) -Tested on Ubuntu 14.04/14.10 in bash/zsh. +Tested on Ubuntu (`ubuntu-latest` in CI) in bash/zsh. Docker ====== @@ -433,11 +438,11 @@ Public ------- ```shell -$ docker pull evkalinin/gh-md-toc:0.7.0 +$ docker pull evkalinin/gh-md-toc:0.10.0 $ docker images | grep toc -evkalinin/gh-md-toc 0.7.0 0b8db6aed298 11 minutes ago 147MB +evkalinin/gh-md-toc 0.10.0 11 minutes ago 147MB -$ docker run -it evkalinin/gh-md-toc:0.7.0 \ +$ docker run -it evkalinin/gh-md-toc:0.10.0 \ https://github.com/ekalinin/envirius/blob/master/README.md ```