{"repo":"ekalinin/github-markdown-toc.go","free":true,"listed":false,"github":"https://github.com/ekalinin/github-markdown-toc.go","clone":"git clone https://github.com/ekalinin/github-markdown-toc.go.git","description":"Easy TOC creation for GitHub README.md (in go)","language":"Go","stars":524,"topics":["toc","golang","github","markdown","table-of-contents","go","readme"],"license":"MIT","category":"productivity","readme_excerpt":"github-markdown-toc =================== This is a golang based implementation of the github-markdown-toc tool. The advantages of this implementation: no dependencies (no need curl, wget, awk, etc.) cross-platform (support for Windows, Mac OS, etc.) regexp for parsing TOC parallel processing of multiple documents Attention : gh-md-toc is able to work properly only if your machine is connected to the Internet. Table of Contents ================= github-markdown-toc Installation Precompiled binaries Compiling from source Go Install Homebew (Mac only) Tests Usage STDIN Local files Remote files Multiple files Combo Insert into a file Skip header Starting Depth Depth No Escape Github token GitHub Enterprise Server Bash/ZSH auto\\-complete Alpine Linux LICENSE Created by gh-md-toc Installation ============ Precompiled binaries -------------------- See the releases page, \"Downloads\" section: https://github.com/ekalinin/github-markdown-toc.go/releases For example: The first line is the bare version number, so scripts that parse gh-md-toc --version will continue to work. Compiling from source --------------------- You need Go 1.26 or newer installed in your OS: Go Install ------------------ You need Go 1.26 or newer installed in your OS: Homebew (Mac only) ------------------ Tests ===== Usage ===== STDIN ----- Here's an example of TOC creating for markdown from STDIN: Local files ----------- Here's an example of TOC creating for a local README.md: Remote files ------------ And here's an","default_branch":null,"files":null,"tree":[],"storefront":"/r/ekalinin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ekalinin/github-markdown-toc.go/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."}