Insert human-friendly link via completion

[WhyNotHugo]

Verify

• I searched the existing discussions for similar ideas

Share your idea or feature request

When using markdown style links, the LSP will insert links in the style of:

[xyz1_my_page_title](xyz1_my_page_title)

It would make a lot more sense to use:

[my_page_title](xyz1)

I.e.: put the page title in the visible part of the link, and the id as the link target.

Solution 1

Allow customising how links are generated by the LSP with a new link_template option. This is the most flexible, but might be an overkill

Solution 2

Simply change the format used to the one proposed. Less flexible but it's a nicer experience, IMHO.

[tjex]

By "insert links" do you mean via lsp completion or via ZkInsertLink?

In any case, a markdown link requires [title](path) no? id couldn't be substituted for path?

And the link format options in the config file don't suffice / lead you to any preexisting solution?
i.e, use a custom template for building the link.

# MARKDOWN SETTINGS
[format.markdown]

# Format used to generate links between notes.
# Either "wiki", "markdown" or a custom template. Default is "markdown".
link-format = "markdown"

[WhyNotHugo]

You can't just use the id as the path portion of a markdown link. Because it is not a file path. It is just the id.

The LSP happily follows links with an id-only just fine.

I'm aware that trying to generate html pages for these markdown file would generate broken links tho, so I'm considering renaming them to simply {{id}}.md.

It will work if you link to notes in the same folder, but if you try to link to a note in a different folder, the link will not resolve. i.e, the note will not be found.

I keep all my notes in one directory, if that's what you mean. But fair warning, I think I'll have to use full paths.

---

I think that {{id}} not working might be a bug.

[tjex]

Just for the sake of saving confusion for others: the LSP will not just follow links with only an id by default. This is only working for you because your filenames are the id.

Here is an example:

[format.markdown]

# Format used to generate links between notes.
# Either "wiki", "markdown" or a custom template. Default is "markdown".
link-format = "[{{title}}]({{metadata.id}})"

./test file - etkc.md:

  6 ---
  5 id: etkc
  4 ---
  3
  2 # test file
  1
7   [other](gn68) <- resolves fine.

./gn68.md

    6 ---
    5 id: gn68
    4 ---
    3 # other
    2
    1
E 7   [test file](etkc)     ■ not found

[WhyNotHugo]

From what I can tell, the LSP is pretty flexible. If my note is called gn68_streaming.md, a link with just gn68 works fine.

[tjex]

huh, true. Just renamed the above to etkc_test-file.md, and it does resolve now. Nice find and good to have it clarified. Mickael has seemingly sprinkled lots of hidden gems through zk.

[mickael-menu]

Here's the logic to resolve a note:

zk/internal/adapter/lsp/server.go

Lines 524 to 530 in 7ae8a39

	// noteForLink returns the Note object for the note targeted by the given link.
	//
	// Match by order of precedence:
	// 1. Prefix of relative path
	// 2. Find any occurrence of the href in a note path (substring)
	// 3. Match the href as a term in the note titles
	func (s *Server) noteForLink(link documentLink, notebook *core.Notebook) (*Note, error) {

Although the comment seems outdated, it doesn't match note titles anymore, only path prefixes and unique path portions.