Navigate between Mardown heading with ease
Explore the docs »
·
Report Bug
·
Request Feature
Markdow Headers is a lightweight and intuitive Neovim plugin designed to enhance navigation within Markdown files. Whether you're creating study notes, documentation, or any Markdown-formatted text, this plugin streamlines the process of moving between sections and headings.
- Heading List: Quickly access a clean list of all Markdown and HTML headings in your file.
- Effortless Navigation: Jump to specific sections with ease, improving overall file navigation.
- Treesitter Integration: Boosted accuracy through the use of Treesitter for parsing Markdown and HTML structures.
- Customization Options: Tailor the plugin to your preferences with customizable settings, including width, height, border characters, and the ability to control auto-closing behavior, and last but not least colors.
Markdown Headers emerged from my own struggles and frustrations while working with extensive Markdown files during exam preparations. As a student who heavily relies on Markdown for organizing and summarizing course materials, navigating through numerous headings became a cumbersome task. This plugin is my response to that challenge.
It exists to offer a practical solution for anyone who regularly works with Markdown, whether for academic notes, technical documentation, or personal projects. The goal is to make the Markdown editing experience in Neovim more enjoyable and efficient, improving your productivity.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion/improvement that would make this project better, please fork the repo and create a pull request. You can also simply open an issue with the tag enhancement.
A star to the repo would be greatly appreciated (only if you want to, you don't have to if you don't want to)!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/amazing-feature) - Commit your Changes (
git commit -m 'Add some amazing-feature') - Push to the Branch (
git push origin feature/amazing-feature) - Open a Pull Request
See CONTRIBUTING.md for more information.
Markdown Headers is licensed under the MIT License. See the LICENSE.md file for more information.