{"id":23557406,"url":"https://github.com/yousefakbar/toc.nvim","last_synced_at":"2025-05-15T23:30:42.091Z","repository":{"id":269726847,"uuid":"907976248","full_name":"yousefakbar/toc.nvim","owner":"yousefakbar","description":"Telescope-integrated Markdown TOC Explorer","archived":false,"fork":false,"pushed_at":"2025-01-03T01:10:50.000Z","size":6,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-17T14:45:14.250Z","etag":null,"topics":["markdown","neovim","neovim-plugin","nvim","plugin","table-of-contents","toc"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yousefakbar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-12-24T18:52:49.000Z","updated_at":"2025-01-27T13:51:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"f62fa40b-1c3c-40b8-bcbb-2609e62da418","html_url":"https://github.com/yousefakbar/toc.nvim","commit_stats":{"total_commits":8,"total_committers":1,"mean_commits":8.0,"dds":0.0,"last_synced_commit":"9720d2931527668814f29623421f4e00b6167956"},"previous_names":["yousefakbar/toc.nvim"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yousefakbar%2Ftoc.nvim","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yousefakbar%2Ftoc.nvim/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yousefakbar%2Ftoc.nvim/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yousefakbar%2Ftoc.nvim/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yousefakbar","download_url":"https://codeload.github.com/yousefakbar/toc.nvim/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442163,"owners_count":22071859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","neovim","neovim-plugin","nvim","plugin","table-of-contents","toc"],"created_at":"2024-12-26T14:28:58.807Z","updated_at":"2025-05-15T23:30:42.059Z","avatar_url":"https://github.com/yousefakbar.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Overview\n\n`toc.nvim` is a Neovim plugin that allows users to navigate Markdown headings in the current buffer using a Telescope picker. With this plugin, you can quickly jump to any heading in your document, enhancing productivity and ease of navigation.\n\n# Features\n\n- Parse and list all Markdown headings in the current buffer.\n- Seamless integration with Telescope for fuzzy searching.\n- Instant navigation to the selected heading.\n- User-friendly interface with customizable key mappings.\n\n# Dependencies\n\n- [Neovim (with lua support)](https://neovim.io/) \u003e= 0.5\n- [Telescope.nvim](https://github.com/nvim-telescope/telescope.nvim)\n\n# Installation\n\nTo install the plugin using [lazy.nvim](https://github.com/folke/lazy.nvim), add the following configuration to your Neovim setup:\n\n```lua\n{\n    \"yousefakbar/toc.nvim\",\n    ft = \"markdown\",\n    opts = {},\n    keys = { -- Optional if you want to define a keymap to launch :Toc\n        { \"\u003cleader\u003emc\", \"\u003cCMD\u003eToc\u003cCR\u003e\", desc = \"Table of contents\" },\n    },\n}\n```\n\nOtherwise, follow the specific steps for your plugin manager.\n\n# Usage\n\n1. Open a Markdown file in Neovim.\n2. Run the command `:Toc` to open the Telescope picker with all the headings from the current buffer.\n3. Use the fuzzy search functionality to find a heading.\n4. Press `\u003cEnter\u003e` to navigate directly to the selected heading in the file.\n\n# How It Works\n\n1. **Heading Extraction**: The plugin scans the current buffer for Markdown headings (`#`, `##`, `###`, etc.) and organizes them in a table with their titles, line numbers, and levels.\n2. **Telescope Integration**: The extracted headings are passed to Telescope, enabling users to search and select headings easily.\n3. **Navigation**: Upon selecting a heading, the plugin jumps to the corresponding line in the document.\n\n# Configuration\n\nCurrently, the plugin requires no additional configuration. However, you can extend its functionality or integrate it with your existing Neovim setup using the provided `setup` function.\n\n# Contributing\n\nFeel free to contribute to this project! Submit issues or pull requests on the [GitHub repository](https://github.com/yousefakbar/toc.nvim)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyousefakbar%2Ftoc.nvim","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyousefakbar%2Ftoc.nvim","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyousefakbar%2Ftoc.nvim/lists"}