{"repo":"ChuufMaster/markdown-toc","free":true,"listed":false,"github":"https://github.com/ChuufMaster/markdown-toc","clone":"git clone https://github.com/ChuufMaster/markdown-toc.git","description":"Generate inteligent customisable markdown TOC with affordances for emojis and relative file paths.","language":"Lua","stars":16,"topics":["github","markdown","neovim","neovim-plugin","nvim","plugin","toc-generator"],"license":"MIT","category":"productivity","readme_excerpt":"🧐 What is markdown-toc? A Neovim plugin to generate, update and delete TOCs (Table of Contents) in a markdown file from another markdown files headings 🗂️ Markdown-TOC TOC - 🧐 What is markdown-toc? - 🗂️ Markdown-TOC TOC - ✨ Features - ⚡️ Requirements - 📦 Installation - 🚀 Usage - ⚙️ Configuration ✨ Features - Telescope picker to select the file to generate the TOC from - Customisable level of headings to generate - Customisable format string - Update a table if you are inside of TOC it when calling GenerateTOC - Markdown-TOC uses relative file paths so you won't have to worry about where the file you are using to generate the TOC is - Markdown-TOC properly encodes headings with emojis handling emojis that need special delimiters and others that don't ⚡️ Requirements - Neovim =0.10 - Telescope.nvim 📦 Installation Install the plugin with your preferred package manager: 💤 Lazy.nvim 🚀 Usage Markdown TOC exposes 2 commands to the user: - GenerateTOC : this opens up a telescope prompt for your cwd to select an markdown file to generate the TOC from - GenerateTOC : can also take in 1 argument as a number which will set the heading level to that argument overriding the default heading level set in your config and will also ignore if you set to ask for heading level - DeleteTOC : If your cursor is inside of a TOC matching when calling this command the default TOC format it will delete the table ⚙️ Configuration markdown-toc comes with the following defaults:","default_branch":null,"files":null,"tree":[],"storefront":"/r/ChuufMaster","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/ChuufMaster/markdown-toc/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."}