Franklin.jl icon indicating copy to clipboard operation
Franklin.jl copied to clipboard

Add Features Support for Digital Garden User Case: Wiki Links, Back Links and Link Preview

Open RoyiAvital opened this issue 4 years ago • 5 comments

It will be great to be able to use Franklin for Digital Garden like use case.

The missing features are:

  1. Wiki Links.
    Being able to generate links to local md files by [[relative\path\to\md\file]].
  2. Backlinks
    At each post to list the set of other pages which links to it.
  3. Link Preview
    On hovering a link to show a preview of it.

There are more features like the option to have Sliding Window Mode like in Andy Matuschak's Notes.

The idea is to support generating information sources which are easy to navigate an generate contexts.

Some examples in Jekyll:

  1. Simply Jekyll.
  2. Note Note Link.

RoyiAvital avatar May 21 '21 21:05 RoyiAvital

Thanks for this! (1) is already available, this is available for instance on the Julia website if you look at the bottom right there's a floating pen in a blueish bubble, clicking on this leads to the MD page, is that what you're thinking about but more streamlined?

ok for the rest, we can look into what's needed for this, I think (2) would be a reasonably easy PR, I'm not sure about (3)?

tlienart avatar May 22 '21 09:05 tlienart

I don't mean the RAW MD File. I mean linking to other notes can be done in the fashion of [[]].

You may have a look at Obsidian documentation for the idea. They are also called Internal Links.

RoyiAvital avatar May 22 '21 09:05 RoyiAvital

you can already do internal links though with the usual markdown syntax ([...]). The docs you're linking to is basically an additional syntax ([[..]]) which keeps track of what internal page link to what other internal page?

Even if this stuff is 100% clear for you, it's not yet to me so it's useful to add as much explicit implementation details as possible here, not linking to external stuff as I probably won't have time to read all of it in depth before a while. Though if there's a clear summary of what needs to be implemented here, there's a higher chance it lands in the code base soon if it's easy to do.

tlienart avatar May 24 '21 08:05 tlienart

OK, I will try to explain it in a short post here.

RoyiAvital avatar May 24 '21 18:05 RoyiAvital

It seems that a perfect demo is already made in this website Exploring the features of Simply Jekyll

By the way, I am very glad to contribute and make this available in Franklin.jl.

ChasingZenith avatar Sep 23 '21 03:09 ChasingZenith