Shadowgraph
About
Sign in

Lirt/markdown-toc-bash

Bash script to generate table of contents from markdown file (README.md)

34

stars

4

commits

Shell

primary language

Jun 11, 2024

updated

README

Markdown ToC

Simple bash script to generate table of contents from a markdown file (most commonly README.md)

Table of Contents

Usage

Only dependency is bash.

To generate ToC, run following command. The ToC will be echoed to command line. Afterwards you can put the ToC output into your markdown file and it will link your headings.

./markdown-toc.sh README.md

Contribution

Any issues or improvements can be reported using GitHub issues.

Contributors

Lirt

4 commits

Similar repos

jonschlinkert/markdown-toc

API and CLI for generating a markdown TOC (table of contents) for a README or any markdown files.…

1,754

hukkin/mdformat-toc

Mdformat plugin to generate a table of contents

27

KevinGimbel/mktoc

🦀 Markdown Table of Content generator

23

syntax-tree/mdast-util-toc

utility to generate a table of contents from an mdast tree

88

abhinav/goldmark-toc

Support for generating Tables of Contents from goldmark Markdown documents.

26

thlorenz/doctoc

📜 Generates table of contents for markdown files inside local git repository. Links are compatible…

4,464

remarkjs/remark-toc

plugin to generate a table of contents (TOC)

498

JS-DevTools/rehype-toc

A rehype plugin that adds a table of contents (TOC) to the page

83

Languages

Shell

100.0%

Lirt/markdown-toc-bash

Bash script to generate table of contents from markdown file (README.md)

34

stars

4

commits

Shell

primary language

Jun 11, 2024

updated

README

Markdown ToC

Simple bash script to generate table of contents from a markdown file (most commonly README.md)

Table of Contents

Usage

Only dependency is bash.

To generate ToC, run following command. The ToC will be echoed to command line. Afterwards you can put the ToC output into your markdown file and it will link your headings.

./markdown-toc.sh README.md

Contribution

Any issues or improvements can be reported using GitHub issues.

Similar repos

jonschlinkert/markdown-toc

API and CLI for generating a markdown TOC (table of contents) for a README or any markdown files.…

1,754

hukkin/mdformat-toc

Mdformat plugin to generate a table of contents

27

KevinGimbel/mktoc

🦀 Markdown Table of Content generator

23

syntax-tree/mdast-util-toc

utility to generate a table of contents from an mdast tree

88

abhinav/goldmark-toc

Support for generating Tables of Contents from goldmark Markdown documents.

26

thlorenz/doctoc

📜 Generates table of contents for markdown files inside local git repository. Links are compatible…

4,464

remarkjs/remark-toc

plugin to generate a table of contents (TOC)

498

JS-DevTools/rehype-toc

A rehype plugin that adds a table of contents (TOC) to the page

83

Contributors

Lirt

4 commits

Languages

Shell

100.0%