Foam: Search for hosted Foam?

Created on 8 Sep 2020  路  6Comments  路  Source: foambubble/foam

Problem Statement:

No documented way to quickly enable a basic search of a foam project that is hosted on github pages.

Benefits:

I often want to look through my Foam instance in the browser and also be able to share it with others. Whilst I appreciate that browsing my Foam locally means I can use VScode's search, it would greatly expand the use cases for Foam in general.

Considerations:

Probably only beneficial to a portion of users, however search is a pretty defined feature and a really basic implementation would already be really useful. It seems there are front-end frameworks like lunr.js which could do so in a light-weight way. Unfortunately I'm not fully versed on how Foam works when hosted, or I'd offer to try building a plugin.

Most helpful comment

try this one foam-mkdocs-template with media-wiki links rendering (also support obsidian workspace), it looks like this:

https://jackiexiao.github.io/foam/
image

when I have time, I will collect different template from foam users (for example: #259 ) and add to foam document

All 6 comments

@jetk A published Foam workspace is simply a Jekyll generated static website, so I'd assume this would work: christian-fei/Simple-Jekyll-Search.

My approach of this is integrating Algolia into the site. Though if you want it to fit into your own needs, this will still need some level of customization.

Using jekyll-algolia and my own Jekyll page block https://github.com/hikerpig/wiki/blob/master/_includes/algolia.html

image

try this one foam-mkdocs-template with media-wiki links rendering (also support obsidian workspace), it looks like this:

https://jackiexiao.github.io/foam/
image

when I have time, I will collect different template from foam users (for example: #259 ) and add to foam document

@mathieudutour also recently added search

https://github.com/mathieudutour/gatsby-digital-garden
https://mathieudutour.github.io/gatsby-digital-garden/

He has a template for Foam too!

Thanks all for the suggestions! Feel like this would be a good battery-included feature for Foam in general but for now I'll implement myself thanks to y'all pointing me in the right direction.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jsjoeio picture jsjoeio  路  6Comments

Josh2K picture Josh2K  路  3Comments

WoutV picture WoutV  路  5Comments

sahil48 picture sahil48  路  3Comments

jsjoeio picture jsjoeio  路  5Comments