Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ChuufMaster/markdown-toc
Generate inteligent customisable markdown TOC with affordances for emojis and relative file paths.
https://github.com/ChuufMaster/markdown-toc
github markdown neovim neovim-plugin nvim plugin toc-generator
Last synced: about 1 month ago
JSON representation
Generate inteligent customisable markdown TOC with affordances for emojis and relative file paths.
- Host: GitHub
- URL: https://github.com/ChuufMaster/markdown-toc
- Owner: ChuufMaster
- License: mit
- Created: 2024-06-13T12:44:14.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-08-28T08:26:06.000Z (4 months ago)
- Last Synced: 2024-08-28T09:44:33.686Z (4 months ago)
- Topics: github, markdown, neovim, neovim-plugin, nvim, plugin, toc-generator
- Language: Lua
- Homepage:
- Size: 21.5 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-neovim - ChuufMaster/markdown-toc - Generate TOC in any markdown file from any other markdown file with customisable levels of headings and affordances for emojis and ensuring that it works on GitHub using relative paths. (Programming Languages Support / Markdown and LaTeX)
README
# 🧐 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?](<#-what-is-markdown-toc?>)
- [🗂️ Markdown-TOC TOC](<#%EF%B8%8F-markdown-toc-toc>)
- [✨ Features](<#-features>)
- [⚡️ Requirements](<#%EF%B8%8F-requirements>)
- [📦 Installation](<#-installation>)
- [🚀 Usage](<#-usage>)
- [⚙️ Configuration](<#%EF%B8%8F-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](https://github.com/nvim-telescope/telescope.nvim)
## 📦 Installation
Install the plugin with your preferred package manager:
### 💤 [Lazy.nvim](https://github/folke/lazy.nvim)
```lua
return {
{
'ChuufMaster/markdown-toc',
opts = {
-- The heading level to match (i.e the number of "#"s to match to) max 6
heading_level_to_match = -1,
-- Set to True display a dropdown to allow you to select the heading level
ask_for_heading_level = false,
-- TOC default string
-- WARN
toc_format = '%s- [%s](<%s#%s>)',
}
},
}
```
## 🚀 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:
```lua
{
-- The heading level to match (i.e the number of "#"s to match to)
heading_level_to_match = -1,
-- Set to display a dropdown to allow you to select the heading level
ask_for_heading_level = true,
-- TOC default string
-- The first %s is for indenting/tabs
-- The sencond %s is for the original headings text
-- The third %s is for the markdown files path that the TOC is being generated
-- from
-- The forth %s is for the target heading using the markdown rules
toc_format = '%s- [%s](<%s#%s>)',
}
```