Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add edit_dirs option #184

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Jasha10
Copy link

@Jasha10 Jasha10 commented Dec 12, 2023

Hello,

This PR adds an edit_dirs option that allows users to customize how MkdnEnter will behave when following a link that points to a directory (e.g. [foo](../bar/)).

Before this PR, :MkdnEnter would prompt the user to pick a file name within the given directory:
image

This default behavior is preserved with the new config option edit_dirs = false.

If edit_dirs is true, then running :MkdnEnter on the link [foo](../bar/) is equivalent to running :edit <path> where is the absolute version of ../bar/. This enables the user's default directory-browsing plugin (e.g. netrw or oil.nvim) to open the directory.

Here's a screenshot after calling :MkdnEnter with edit_dirs = true to edit ../bar/ with netrw:
image

If edit_dirs is a callback function, then running :MkdnEnter on [foo](../bar/) is equivalent to calling callback(path) where path is the absolute version of ../bar/.

As an example of usage with a callback: in my lua config I currently have edit_dirs = require('mini.files').open so that :MkdnEnter will invoke the mini.files plugin:

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant