Add support for Markdown link extensions #529

sstallion · 2018-07-12T13:57:50Z

This PR is an updated version of #204, which adds support for appending file extensions in Markdown links. This is needed to view wiki files using Markdown viewers such as Gollum and MDwiki. By default, existing behavior is preserved.

timokau · 2018-08-31T18:19:40Z

Merging this would finally make it possible to view and edit vimwiki in an android app (markor).

For anyone who wants to migrate here are two unreadable sed scripts:

[[some link]] -> [some link][some link.md]:
sed -i -e 's/\[\[\([^]]\+\)\]\]/[\1](\1.md)/g' **/*.md
[some text](some link) -> [some text][some link.md]:
sed -i -e 's/\[\([^]]\+\)\](\([^).]\+\))/[\1](\2.md)/g' **/*.md

This may eat your data, don't use it if you don't understand it and don't blame me. Should be executed in the vimwiki dir. I recommend initializing a git repo first and verify the changes afterwards:

cd vimwiki
git init
git add .
git commit -m 'Initial commit'
sed ...
git diff # verify
git reset --hard # in case it went wrong

elliottw · 2018-10-11T18:15:05Z

I've been using this for some time. It has really helped with my iOS workflow. However, I think it can't be merged until other functions are changed as well. I haven't tried many, but VimwikiGenerateLinks still produces old style links that do not have extensions.

sstallion · 2018-10-11T18:16:51Z

It's fairly rare that I use the support functions directly - do you have an idea of what else needs to change? I'm happy to amend the commit.

…

On Thu, Oct 11, 2018 at 1:15 PM elliottw ***@***.***> wrote: I've been using this for some time. It has really helped with my iOS workflow. However, I think it can't be merged until other functions are changed as well. I haven't tried many, but VimwikiGenerateLinks still produces old style links that do not have extensions. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#529 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFtLiIfkqdR3gmRVqI06NUINYlHBF2RIks5uj4qxgaJpZM4VM5ll> .

elliottw · 2018-10-11T18:54:33Z

It's rare that I use them too. I'm just hypothesizing that these changes couldn't be merged if they produce links that are inconsistent with the links that support functions create. I'm not sure what other functions would need changes, probably a search for all functions that create links would be a good start.

(see: vimwiki#529)

ranebrown · 2019-03-11T21:56:35Z

@sstallion Did you ever look into which functions need modifed such as VimwikiGenerateLinks
I've been added as a maintainer and I'm looking into getting this merged in.

sstallion · 2019-03-12T03:06:23Z

Hey Rane - I haven't. I'll try and take a look this weekend and see if I can nail down what needs to change.

…

On Mon, Mar 11, 2019 at 4:56 PM Rane Brown ***@***.***> wrote: @sstallion <https://github.com/sstallion> Did you ever look into which functions need modifed such as VimwikiGenerateLinks I've been added as a maintainer and I'm looking into getting this merged in. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#529 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFtLiFHnOrHyZ3DqV3mP7sMHNjocGKFNks5vVtEXgaJpZM4VM5ll> .

ranebrown · 2019-03-13T15:22:46Z

So I think there are 3 issues that need addressed:

VimwikiGenerateLinks does not generate markdown style links and they do not have the .md extension. (VimwikiDiaryGenerateLinks does work correctly though so that could be useful to look at)
VimwikiTOC generates links with a .md extension which should not be present. The links work but don't make sense since they are linking to sections within the document.
VimwikiCheckLinks does not handle markdown style links.

Let me know if you see anything else when you get a chance to look at it.

ranebrown · 2019-03-14T03:54:44Z

@sstallion when you get a chance to work on this some more please make the pull request against the dev branch instead of master. I did a quick test and the only difference I saw was in autoload/vimwiki/vars.vim. The variables are now set in the function s:read_global_settings_from_user(). You will need to use this format:

 \ 'markdown_link_ext': {'type': type(0), 'default': 0, 'min': 0, 'max': 1},

We are working to make the contributing guidelines more accessible and clear but for now they are only stored on the dev branch. CONTRIBUTING.md

sstallion · 2019-03-19T02:21:00Z

@ranebrown PR should be ready to go - this should cover the cases mentioned. I wasn't able to come up with anything else, but I'm happy to take a look if any issues are reported.

ranebrown · 2019-03-19T14:23:39Z

@sstallion I just tried to test your changes and things aren't working as expected. Following links does not seem to work correctly and the TOC is broken. I haven't had time to look at the code yet.

Are all the commands and general behavior working as expected for you?

sstallion · 2019-03-19T14:42:58Z

That's strange. Which syntax are you using?

…

On Tue, Mar 19, 2019 at 9:23 AM Rane Brown ***@***.***> wrote: @sstallion <https://github.com/sstallion> I just tried to test your changes and things aren't working as expected. Following links does not seem to work correctly and the TOC is broken. I haven't had time to look at the code yet. Are all the commands and general behavior working as expected for you? — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#529 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFtLiIzQkP3xg2D0uaztZYLrtqkn73Tfks5vYPLvgaJpZM4VM5ll> .

sstallion · 2019-03-19T14:44:03Z

Scratch that. You're absolutely right, TOC's are broken. I must have botched that in a later change. I'll submit a fix shortly.

…

On Tue, Mar 19, 2019 at 8:43 AM Steven Stallion ***@***.***> wrote: That's strange. Which syntax are you using? On Tue, Mar 19, 2019 at 9:23 AM Rane Brown ***@***.***> wrote: > @sstallion <https://github.com/sstallion> I just tried to test your > changes and things aren't working as expected. Following links does not > seem to work correctly and the TOC is broken. I haven't had time to look at > the code yet. > > Are all the commands and general behavior working as expected for you? > > — > You are receiving this because you were mentioned. > Reply to this email directly, view it on GitHub > <#529 (comment)>, or mute > the thread > <https://github.com/notifications/unsubscribe-auth/AFtLiIzQkP3xg2D0uaztZYLrtqkn73Tfks5vYPLvgaJpZM4VM5ll> > . >

ranebrown · 2019-03-19T15:16:11Z

No worries. I think some other things besides the TOC had issues as well such as the diary links. Try to test with different variations such as spaces in the link/header name etc.

sstallion · 2019-03-19T16:14:53Z

@ranebrown Give this a shot - it looks like I was a bit overzealous with checking links in the last changeset. I double checked VimwikiTOC, VimwikiCheckLinks, diaries, and link navigation - all seems to be working correctly.

ranebrown · 2019-03-19T21:23:42Z

Seems good now! I'm going to spend a bit more time looking this over tonight and get it merged if I don't see any other issues.

sstallion · 2019-03-19T22:55:39Z

SGTM. Thanks!

…

On Tue, Mar 19, 2019 at 4:23 PM Rane Brown ***@***.***> wrote: Seems good now! I'm going to spend a bit more time looking this over tonight and get it merged if I don't see any other issues. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#529 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AFtLiOx9kN06ex2LgMXJVrjJnBFeUvVMks5vYVVggaJpZM4VM5ll> .

As of commit 7d82c75, vimwiki adds extensions to links created by vimwiki. This is important for use with other programs, such as Markor. See vimwiki/vimwiki#529

add1989 · 2020-03-01T21:52:16Z

Does anybody know when this can be expected to make it into the master branch?

ascii78 · 2020-05-03T17:20:11Z

For those trying to use this you need:

let g:vimwiki_markdown_link_ext = 1

in your .vimrc

andrewlu000 · 2025-07-17T15:44:16Z

This is awesome. Thank you!

sstallion changed the title ~~Add support for Markdown link extensions (Updated)~~ Add support for Markdown link extensions Jul 12, 2018

timokau mentioned this pull request Aug 31, 2018

Vimwiki support gsantner/markor#317

Closed

julesferreira added a commit to julesferreira/vimwiki that referenced this pull request Feb 26, 2019

include .md extension in markdown links

1f9348e

(see: vimwiki#529)

julesferreira added a commit to julesferreira/vimwiki that referenced this pull request Feb 26, 2019

include .md extension in markdown links

149b577

(see: vimwiki#529)

julesferreira added a commit to julesferreira/vimwiki that referenced this pull request Feb 26, 2019

include .md extension in markdown links

b5e3000

(see: vimwiki#529)

ranebrown self-assigned this Mar 12, 2019

hq6 mentioned this pull request Mar 14, 2019

Markdown link extension #204

Closed

sstallion changed the base branch from master to dev March 18, 2019 21:44

Initial commit

eb00d30

ranebrown mentioned this pull request Mar 19, 2019

Still getting vimwiki links instead of markdown links on :VimwikiDiaryGenerateLinks #623

Closed

ranebrown merged commit 7d82c75 into vimwiki:dev Mar 20, 2019

ranebrown mentioned this pull request Mar 20, 2019

change format of wiki links with markdown syntax from [link](link) to [link](link.mkd) #233

Closed

hq6 mentioned this pull request Mar 25, 2019

Missing extension for markdown links #203

Closed

ranebrown mentioned this pull request Mar 27, 2019

VimwikiGenerateTags format: remove indentation and input correct link format for markdown syntax #231

Closed

ranebrown mentioned this pull request Apr 6, 2019

configuration and markdown links #246

Closed

lucasdf mentioned this pull request Feb 2, 2020

Keep VimwikiBacklinks compatibility with wikilink in markdown wiki #816

Closed

This was referenced Mar 29, 2020

Long time no release #842

Closed

Fix markdown-style link detection #259

Closed

Add support for Markdown link extensions #529

Add support for Markdown link extensions #529

Uh oh!

Conversation

sstallion commented Jul 12, 2018

Uh oh!

timokau commented Aug 31, 2018

Uh oh!

elliottw commented Oct 11, 2018

Uh oh!

sstallion commented Oct 11, 2018 via email

Uh oh!

elliottw commented Oct 11, 2018

Uh oh!

ranebrown commented Mar 11, 2019

Uh oh!

sstallion commented Mar 12, 2019 via email

Uh oh!

ranebrown commented Mar 13, 2019

Uh oh!

ranebrown commented Mar 14, 2019

Uh oh!

sstallion commented Mar 19, 2019

Uh oh!

ranebrown commented Mar 19, 2019

Uh oh!

sstallion commented Mar 19, 2019 via email

Uh oh!

sstallion commented Mar 19, 2019 via email

Uh oh!

ranebrown commented Mar 19, 2019

Uh oh!

sstallion commented Mar 19, 2019

Uh oh!

ranebrown commented Mar 19, 2019

Uh oh!

sstallion commented Mar 19, 2019 via email

Uh oh!

add1989 commented Mar 1, 2020

Uh oh!

ascii78 commented May 3, 2020

Uh oh!

andrewlu000 commented Jul 17, 2025

Uh oh!

Uh oh!