Skip to content

About

Access Markdown file table of content ( titles )

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

8 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

markdown-toc.nvim

License: MIT Sponsor on GitHub

A lightweight, high-performance, plugin to access markdown file headings (Table Of Content) with auto integrations with Telescope

🚀 Features

✅ Auto integrations with Telescope if installed and if not will use native vim.select

📦 Installation

vim.pack.add({
    "https://github.com/janecodelife/markdown-toc.nvim",
    "https://github.com/nvim-telescope/telescope.nvim" -- Optional
})

-- Setup and configure the plugin
require("markdown-toc").setup({
    min_level = 1, -- Include everything from level 1 (#)
    max_level = 6, -- Down to level 6 (######)
})

vim.keymap.set("n", "<leader>mo", "<cmd>MarkdownTOC<cr>", { desc = "Markdown Open TOC" })

⚙️ Configuration

Option Type Default Description
min_level number 1 The minimum markdown heading depth to parse into the table of contents list.
max_level number 6 The maximum markdown heading depth to parse into the table of contents list.

Video 📺

markdown-toc-video


💝🤟 Support the Project 🤟💝

Become a Sponsor on GitHub

Every bit of support fuels the expansion of this ecosystem and helps me write cleaner tools for all of us. Thank you for standing behind independent developers!_ 🙏🤟


💝🤟 A huge thank you to our sponsors! 💝🤟


🔗 My Other Plugins

Check out my other open-source tools to supercharge your Neovim environment:


If Have A Question 🤝 (Contact Me) 🤟

I will be there to answer to all messages

Follow on X Subscribe on YouTube


Upcoming 🚀 (Stay Tuned!)

The Ultimate Neovim Config for All Modern Web & Laravel Devs ⚡

Thank You

About

Access Markdown file table of content ( titles )

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Sponsor this project

Packages

Contributors

Languages