Display rendered markdown in search results and hover preview

jackyzha0 / quartz

🌱 a fast, batteries-included static-site generator that transforms Markdown content into fully functional websites

https://quartz.jzhao.xyz

MIT License

7.15k stars 2.51k forks source link

Display rendered markdown in search results and hover preview #113

Closed classicrob closed 2 years ago

classicrob commented 2 years ago

Is your feature request related to a problem? Please describe. Markdown formatting, particularly markdown links, can be jarring to look at for a reader. Additionally, markdown links are long, so they take up most of the space in the preview.

Describe the solution you'd like I would like it to show rendered markdown in the search results, hover preview, and upcoming contextual backlinks. This will dramatically improve the reader experience with heavily formatted text.

Additional context Some examples: it may the case that the issue is with aliases?

aidenybai commented 2 years ago

Wondering if this can be accomplished by using something like marked to render the markdown as HTML inside https://github.com/jackyzha0/quartz/blob/hugo/assets/js/popover.js#L16-L21

jackyzha0 commented 2 years ago

Not perfect but a rough attempt at smoothing out some edges with interpreting Markdown in search/popover contexts https://github.com/jackyzha0/quartz/commit/b21b27d1d3d68bfb4d285f39122a154fceefb9ab

@aidenybai I want to avoid overhead of loading an entire JS library when I don't need to :))

jackyzha0 commented 2 years ago

Closing for now but feel free to reopen if you are looking for something else

classicrob commented 2 years ago

Hey Jacky, I love you, thank you! I know I'm requesting a bunch of things but these are important primitives for digital garden creators and I think your theme is the best I've seen so far. Lmk if you wanna chat some time to discuss further.

I have a few fancy and interesting ideas, as well as things I consider base requirements (e.g hover preview and contextual backlinks) and this is coming along really nicely.

jackyzha0 commented 2 years ago

Hey Jacky, I love you, thank you! I know I'm requesting a bunch of things but these are important primitives for digital garden creators and I think your theme is the best I've seen so far. Lmk if you wanna chat some time to discuss further.

I have a few fancy and interesting ideas, as well as things I consider base requirements (e.g hover preview and contextual backlinks) and this is coming along really nicely.

Would love to chat at some point! I've been collecting a list of things I'd love in my 'end-game' tool for thought but most of them are currently infeasible with the current architecture of Quartz. I do have a plan to incorporate these into an app in the future :))