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

Feature request: first class support for regular markdown links #614

Closed
aignas opened this issue May 7, 2021 · 7 comments
Closed

Feature request: first class support for regular markdown links #614

aignas opened this issue May 7, 2021 · 7 comments
Labels
enhancement New feature or request Markdown NeuronNG/Done Done in Neuron-NG

Comments

@aignas
Copy link

aignas commented May 7, 2021

I really dig this tool, however, one thing that is half-working for me is the regular markdown links, which would point to the md file as it is on the file system. Reasons for why I think markdown links may be good:

  • I want my notes to be in a private github repo and having some support for the built-in markdown rendering in a mobile browser is a huge plus.
  • Having standard markdown links allows to use [some context](actual-link.md) syntax, which can make the text more natural to read.
  • Not having a specific linking syntax makes the notes more future-proof.

Currently the links work intuitively if all zettels are in the same directory. The user stories I would like to see supported:

  • Given a file foo.md and dir/inside.md, as a user I would like to link to inside.md file by using [some text](dir/inside.md)
  • Given a file dir/foo.md and a dir2/inside.md, as a user I would like to link to inside.md file by using [some text](../dir2/inside.md)

I personally think that allowing links [some text](inside.md) when the inside.md is not in the same directory is confusing, but I think it may be worth to decide this outside the scope of handling the two cases above.

@aignas aignas changed the title First class support for regular markdown links Feature request: First class support for regular markdown links May 7, 2021
@aignas aignas changed the title Feature request: First class support for regular markdown links Feature request: first class support for regular markdown links May 7, 2021
@srid srid added the enhancement New feature or request label May 7, 2021
@srid
Copy link
Owner

srid commented May 7, 2021

By half-working you mean #543?

I don't understand what the connection of regular markdown links to the dirtree/uptree plugin is.

As for your point no. 2, see #373

But yes, overall having full support for regular markdown links is a good thing.

@aignas
Copy link
Author

aignas commented May 8, 2021

Thanks for the references. I think that #543 is a different issue, but may be related.

In order to illustrate the differences between the behaviours, I have created https://github.com/aignas/srid-neuron-614.

The dirtree works as expected, however links to zettels is not what I would expect. I would expect [my link](dir/inside.md) to work, however, [my link](inside.md) is what works instead and this is not how I would expect markdown links to work.

The uptree plugin as shown in the screenshot is only built when using standard [[my-zettel]]# links.

@srid srid added the Markdown label May 8, 2021
@srid
Copy link
Owner

srid commented May 8, 2021

Supporting links like [my link](dir/inside.md) or even [my link](../dir/inside.md) (if you are trying to link from a subfolder to to something in its sibling) were never thought of, but yea - it'd be good to have that.

The uptree plugin behaves as expected, as it looks only at the folgezettel subset of the graph, and as such it looks only at folgezettel links, which is what links with a # do. See https://neuron.zettel.page/folgezettel

@aignas
Copy link
Author

aignas commented May 8, 2021

I see. It seems that having propper uplinks requires the neuron-specific syntax but I guess in this case it may be better not to overload the markdown syntax with support for [foo](bar.md)# and #[foo](bar.md) because markdown would look really weird with that.

Shall we set the scope of the feature request only on the link supporting then?

EDIT: Updated the issue description to be more specific.

@srid
Copy link
Owner

srid commented May 8, 2021

See #373 for folgezettels with custom link text.

Markdown links will remain non-folgezettel.

@aignas
Copy link
Author

aignas commented May 8, 2021

Makes sense, thank you for clarification.

@srid srid added the NeuronNG/Done Done in Neuron-NG label May 22, 2021
@srid
Copy link
Owner

srid commented Aug 8, 2021

Closing per https://neuron.zettel.page/next ... to further discuss this idea, post in Emanote repo.

Regular Mardown links should work on Emanote, if not please open an issue in that repo.

@srid srid closed this as completed Aug 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Markdown NeuronNG/Done Done in Neuron-NG
Projects
None yet
Development

No branches or pull requests

2 participants