Support ![[resource]] syntax like obsidian

UlisseMini commented 2 years ago

Obsidian has a ![[resource]] syntax for embedding things (usually images). I need this for my project since I want to support compiling any obsidian vault to html.

I'd be happy to PR this here & to micromark-extension-wiki-link when I've got time but I'd like to know if this is wanted/how you think it should be implemented first. Thanks!

PS: Not sure if this is the right place for this issue, maybe here would be better?

landakram commented 2 years ago

So sorry for the delay. Haven't had as much time lately to put toward this project.

I'm definitely open for a change to support this and would be happy for you to take a crack at it. We can track in this repo, but yes, the changes would need to be made in the lower-level projects:

https://github.com/landakram/micromark-extension-wiki-link - this is essentially the tokenizer, plus a "parser" (light logic on top of tokenization) that supports rendering directly to HTML nodes. You would change the tokenizer logic here to tokenize the new syntax for embedded resources, as well as change the HTML parser to support outputting the embeds. Not sure what makes sense here exactly for HTML output. We may want to define a type for the embed in the tokenization step and switch based on that.
https://github.com/landakram/mdast-util-wiki-link - this package wires the tokenizer up to parse to/from markdown. It's similar to the HTML "parser" in the other package, so you would need to make changes here to support outputting the embeds in markdown.

rufuspollock commented 2 years ago

Wanting to flag that we did a wiki link parser specifically for Obsidian style links here that was inspired by @landakram work here in this repo: https://github.com/flowershow/remark-wiki-link-plus

(at the time we forked because needs seemed quite a lot simpler and we needed it quite quickly)

ChildishhAlbino commented 11 months ago

If you're still looking for a solution to the ![[Example.jpg]] usage of this - I made a simple remark plugin that does it and works with Astro's parsing and image generation for turning an obsidian vault into a Starlight site for my Dnd campaign.

Let me know if this helps you at all :D this is very thrown together so any feedback is appreciated :D

rufuspollock commented 11 months ago

@ChildishhAlbino great and i note that https://github.com/datopian/remark-wiki-link-plus is a remark plugin and already supports ![[Example.jpg]] (if you want to converge efforts)

ChildishhAlbino commented 11 months ago

@rufuspollock thanks for pointing that out. I'll take a look but will have to see if it supports the same types of configuration options as this plugin.

Jsmithrud37 commented 1 month ago

Any update on this?

Is the datopian library still maintained as a stand-alone library outside of Flowershow? Its README indicates that it is not.

landakram / remark-wiki-link

Support ![[resource]] syntax like obsidian #21