{"repo":"KevinGimbel/mktoc","free":true,"listed":false,"github":"https://github.com/KevinGimbel/mktoc","clone":"git clone https://github.com/KevinGimbel/mktoc.git","description":"🦀 Markdown Table of Content generator","language":"Rust","stars":23,"topics":["rust","markdown","table-of-contents","toc","generator","rust-library","command-line","command-line-tool","cli"],"license":"MIT","category":"cli-tools","readme_excerpt":"mktoc Graphic design is my passion ✨ Table of Contents - About - Installation - Cargo - Binary - Hermit - Nix - Run on demand - Install (nixos / nix-darwin) - Usage - Update Markdown file - Inline config - min depth - max depth - wrap in details - Command line - Environment configuration - Auto-run with VSCode - Performance - Contributing - Where to start? - Tooling - Nix - Install dev build - License About ⬆️ Back to Top mktoc parses markdown files and generates a Table Of Content linking all headlines up to heading level 6 deep, or as specified by command line arguments, environment variables, or inline JSON config (see Usage). Installation ⬆️ Back to Top mktoc can be installed using Cargo, the Rust package manager. Cargo Installation Update Binary Binaries for Linux and MacOS can be downloaded from the release page. Windows Binaries are not yet build automatically, see #7. Hermit mktoc is available in hermit so it can be installed on a per-project basis without the need to install it globally. This installs mktoc to the local bin directory at bin/mktoc inside the project. Nix mktoc is available in nixpkgs since version 25.11. Run on demand Install (nixos / nix-darwin) Usage Update Markdown file ⬆️ Back to Top Add the following HTML comment into the Markdown file where the Table of Contents should be rendered. Everything between those comments will be replaced! Inline config ⬆️ Back to Top Starting with version 3.0.0 it's possible to set values in-line which is great when c","default_branch":null,"files":null,"tree":[],"storefront":"/r/KevinGimbel","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/KevinGimbel/mktoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}