Markdown Toc

Markdown-toc is a utility for generating and maintaining tables of contents within markdown files. It functions as both a command-line interface and a programmatic library, enabling the automated creation of structured navigation links based on the heading hierarchy of a document.

The tool distinguishes itself through its marker-based injection system, which allows for the precise placement and updating of navigation blocks within existing files. It includes a dedicated transformation pipeline for slugifying heading text into URL-friendly identifiers, ensuring that generated links remain consistent and functional as documentation evolves.

Beyond basic generation, the project provides a suite of parsing utilities that extract heading metadata and hierarchy levels. These features support custom documentation workflows, including the ability to filter content, apply depth constraints, and integrate with various markdown rendering engines to facilitate automated documentation maintenance.

Features

Table of Contents Generators - Generates and injects structured table of contents navigation links based on document heading hierarchy.
Document Parsing CLI Tools - Provides a command-line interface for automating table of contents maintenance using configurable insertion markers.
Automatic Table of Contents - Injects generated tables of contents into markdown files using comment markers to define precise insertion points.
Marker-Based Injection Utilities - Uses marker-based injection to precisely place and update generated content blocks within existing markdown files.
Slugification Tools - Provides a transformation pipeline for slugifying heading text into URL-friendly identifiers for consistent link generation.
Hierarchy Traversers - Implements recursive traversal of heading hierarchies to calculate nesting levels for structured navigation.
README Section Injections - Automates the injection and refreshing of table of contents sections within project README files.
Markdown Documentation - Maintains markdown documentation by automating the creation and updating of navigation structures.
Utility Tools - Tool for generating tables of contents for Markdown files.

Star 历史

jonschlinkertmarkdown-toc

Name: jonschlinkert/markdown-toc
Author: jonschlinkert

View on GitHub

1,752 星标711 分支JavaScriptMIT1 次浏览github.com/jonschlinkert

Markdown Toc

Features

Table of Contents Generators - Generates and injects structured table of contents navigation links based on document heading hierarchy.
Document Parsing CLI Tools - Provides a command-line interface for automating table of contents maintenance using configurable insertion markers.
Automatic Table of Contents - Injects generated tables of contents into markdown files using comment markers to define precise insertion points.
Marker-Based Injection Utilities - Uses marker-based injection to precisely place and update generated content blocks within existing markdown files.
Slugification Tools - Provides a transformation pipeline for slugifying heading text into URL-friendly identifiers for consistent link generation.
Hierarchy Traversers - Implements recursive traversal of heading hierarchies to calculate nesting levels for structured navigation.
README Section Injections - Automates the injection and refreshing of table of contents sections within project README files.
Markdown Documentation - Maintains markdown documentation by automating the creation and updating of navigation structures.
Utility Tools - Tool for generating tables of contents for Markdown files.

Markdown Toc 的开源替代方案

相似的开源项目，按与 Markdown Toc 的功能重合度排序。

ekalinin/github-markdown-toc
ekalinin/github-markdown-toc
3,292在 GitHub 上查看
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 bypas
Shellgithubmarkdownshell
在 GitHub 上查看3,292
thlorenz/doctoc
thlorenz/doctoc
4,451在 GitHub 上查看
doctoc is a markdown table of contents generator and file processor designed to automatically create and update linked lists of headings within markdown documents. It functions as a git repository documentation tool that scans local directories to ensure navigation remains consistent across a collection of files. The tool features a GitHub compatible anchor generator that formats heading links to match the specific requirements of GitHub and similar hosting platforms. It manages updates by locating marker comments to replace existing tables of contents without overwriting other document conte
JavaScript
在 GitHub 上查看4,451
miaolz123/vue-markdown
miaolz123/vue-markdown
1,969在 GitHub 上查看
Vue-markdown is a rendering library and component suite designed to transform raw markdown text into structured HTML for use within Vue applications. It functions as a parser that converts text into an intermediate tree structure, allowing for the integration of dynamic content and the application of custom formatting rules during the conversion process. The library distinguishes itself through its component-based architecture, which enables the direct injection of framework-specific components into rendered documents. It provides extensive lifecycle hooks that allow developers to monitor the
JavaScriptmarkdownvuevue-components
在 GitHub 上查看1,969
evilstreak/markdown-js
evilstreak/markdown-js
7,679在 GitHub 上查看
markdown-js is a JavaScript markdown parser and converter that transforms markdown text into HTML output. It functions as both a library and a command line interface tool for converting documents. The project is centered on an abstract syntax tree representation, allowing markdown to be parsed into a structured tree for programmatic inspection and modification before the final rendering process. This intermediate representation enables custom markup processing and document transformations. The toolset covers programmatic document parsing, static site generation, and CLI-based file processing
JavaScript
在 GitHub 上查看7,679

查看 Markdown Toc 的所有 30 个替代方案

包含 Markdown Toc 的精选搜索

收录 Markdown Toc 的精选合集。

层级化文档结构管理工具

常见问题解答

jonschlinkert/markdown-toc 是做什么的？

jonschlinkert/markdown-toc 的主要功能有哪些？

jonschlinkert/markdown-toc 的主要功能包括：Table of Contents Generators, Document Parsing CLI Tools, Automatic Table of Contents, Marker-Based Injection Utilities, Slugification Tools, Hierarchy Traversers, README Section Injections, Markdown Documentation。

jonschlinkert/markdown-toc 有哪些开源替代品？

jonschlinkert/markdown-toc 的开源替代品包括： ekalinin/github-markdown-toc — This project is a command-line utility designed to automate the creation and maintenance of tables of contents within… thlorenz/doctoc — doctoc is a markdown table of contents generator and file processor designed to automatically create and update linked… miaolz123/vue-markdown — Vue-markdown is a rendering library and component suite designed to transform raw markdown text into structured HTML… evilstreak/markdown-js — markdown-js is a JavaScript markdown parser and converter that transforms markdown text into HTML output. It functions… russross/blackfriday — Blackfriday is a Go library for parsing and converting Markdown text into HTML, LaTeX, and other structured formats.… anmol098/waka-readme-stats — waka-readme-stats is an automated profile README updater and developer statistics dashboard. It integrates with the…