# ekalinin/github-markdown-toc

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/ekalinin-github-markdown-toc).**

3,292 stars · 2,694 forks · Shell · MIT

## Links

- GitHub: https://github.com/ekalinin/github-markdown-toc
- awesome-repositories: https://awesome-repositories.com/repository/ekalinin-github-markdown-toc.md

## Topics

`github` `markdown` `shell` `table-of-contents` `toc`

## Description

This project is a command-line utility designed to automate the creation and maintenance of tables of contents within markdown files. It functions as a static documentation processor that parses document headings to generate hierarchical navigation lists, which are then injected directly into the source files.

The tool distinguishes itself by supporting both local files and remote network streams as input sources. It utilizes marker-based content updating to refresh existing navigation sections without requiring manual edits, and it includes authentication support for remote requests to bypass service rate limits when fetching external documentation.

Beyond basic generation, the utility handles the normalization of headings into URL-safe anchor slugs and manages the structural metadata required for consistent document indexing. It is intended to streamline documentation workflows by automating the maintenance of navigation structures in repository files and distributed technical content.

## Tags

### Development Tools & Productivity

- [Automatic Table of Contents](https://awesome-repositories.com/f/development-tools-productivity/documentation-navigation/document-structure-navigators/outline-management/automatic-table-of-contents.md) — Automatically generates, inserts, and refreshes formatted tables of contents by parsing document headings. ([source](https://github.com/ekalinin/github-markdown-toc/blob/master/README.md))
- [README Generators](https://awesome-repositories.com/f/development-tools-productivity/github-integration-tools/readme-generators.md) — Automates the maintenance of navigation structures within repository documentation files to improve reader accessibility.
- [GitHub Repository Utilities](https://awesome-repositories.com/f/development-tools-productivity/github-repository-utilities.md) — Provides utilities to generate structured navigation lists for project README files in GitHub repositories.
- [Static Documentation Generators](https://awesome-repositories.com/f/development-tools-productivity/static-documentation-generators.md) — Acts as a text-parsing engine that extracts document structure from various sources to generate formatted navigation links.

### Web Development

- [Marker-Based Injection Utilities](https://awesome-repositories.com/f/web-development/content-insertion-utilities/dynamic-content-insertion/marker-based-injection-utilities.md) — Maintains persistent navigation sections by injecting content between predefined start and end markers in source files.
- [Table of Contents Generators](https://awesome-repositories.com/f/web-development/table-of-contents-generators.md) — Parses markdown files via command-line to create and inject hierarchical navigation lists based on headings.

### Content Management & Publishing

- [Hierarchical Heading Generation](https://awesome-repositories.com/f/content-management-publishing/content-management-systems/content-architecture-modeling/document-models/document-sectioning/document-content-structuring/flat-heading-hierarchies/hierarchical-heading-generation.md) — Calculates indentation levels and generates URL-safe anchor slugs to structure document headings into a hierarchical tree.
- [Markdown Documentation](https://awesome-repositories.com/f/content-management-publishing/markdown-documentation.md) — Automates the creation and updating of table of contents sections within markdown files to improve navigation.