org-roam-ui icon indicating copy to clipboard operation
org-roam-ui copied to clipboard

[ENH] Static export of org-roam-ui

Open wylited opened this issue 1 year ago • 13 comments

I believe it would be beneficial if statically exporting the ui as a next.js static website was avaiable as an option.

This is currently implemented in jgru's forked branch, however, hasn't been touched in a while and could use some more streamlining improvements to make it easier to use.

I currently have a static export setup, and it is a mild pain to export it each time I update my notes. (view it)

I believe this is beneficial as people would like to share their notes in the amazing website that org-roam-ui provides statically to the whole world, rather than forcing people to manage the org files themselves in a git repo.

Furthermore, I would love to try and implement this myself in my free time, if you don't mind.

wylited avatar Jun 11 '23 15:06 wylited

It seems hover to preview does not work. I wonder what's causing it.

uncomfyhalomacro avatar Jul 20 '23 00:07 uncomfyhalomacro

Nvm. i just fixed it on my own. checking the logs and all

uncomfyhalomacro avatar Jul 20 '23 00:07 uncomfyhalomacro

HMM @wylited maybe i should assign myself for this. I just found out that I can just use the patches from jgru's fork and add my own. not sure if the dev team here wants to move forward but expect a PR soon. it's a very smol change to be honest with some added new org-roam-ui-export and stuff commands

uncomfyhalomacro avatar Jul 20 '23 00:07 uncomfyhalomacro

@uncomfyhalomacro Do you need testers for the UI export you're working on?

Jdogzz avatar Aug 24 '23 22:08 Jdogzz

@uncomfyhalomacro Do you need testers for the UI export you're working on?

i havent started yet since i didnt get a go signal from the maintainers. but i am willing to do it after I am done with personal life stuff. it's very trivial to do so tbh because of @jgru's patches

uncomfyhalomacro avatar Aug 28 '23 06:08 uncomfyhalomacro

@uncomfyhalomacro, please do let us know after you work on it and need testers. This would be really useful for me too!

bmp avatar Sep 05 '23 10:09 bmp

I currently have a static export setup, and it is a mild pain to export it each time I update my notes. (view it)

@wylited May I ask how you've set up the fork? Have you removed org-roam-ui from here and used the https://github.com/jgru/org-roam-ui/tree/add-export-capability version to export it or do you have both of them installed side-by-side (is that even possible?)

bmp avatar Sep 05 '23 10:09 bmp

You could check my repo's readme. There it outlines to use the forked for the org-roam-ui as the package instead, as it provides the same functionality.

I'd love to see this in the main package so that I wouldn't have to deal with selecting the fork.

wylited avatar Sep 05 '23 11:09 wylited

in any case, i will start working on this over mid september, probably around sept 15. i will try to keep up with the upstream changes and PR. i feel like the maintainers are kind of inactive though so i hope once i pr, they will review it.

uncomfyhalomacro avatar Sep 05 '23 14:09 uncomfyhalomacro

in any case, i will start working on this over mid september, probably around sept 15. i will try to keep up with the upstream changes and PR. i feel like the maintainers are kind of inactive though so i hope once i pr, they will review it.

I can also just open a PR of my branch which should merge just fine. Maybe the maintainers agree to incorporate it in view of the general interest.

jgru avatar Sep 05 '23 14:09 jgru

any progress on this?

g4v4g4i avatar Apr 05 '24 13:04 g4v4g4i

Sadly I stopped pondering about it since life just became busier now. I do have a workaround I mentioned here

uncomfyhalomacro avatar Apr 05 '24 15:04 uncomfyhalomacro

Tefkah is most likely busy with life right now. I was hoping to be able to provide more development support on org-roam and org-roam-ui as I'm young, I use org-roam quite a bit, and I'm free enough to work on it. Unfortunately, I just haven't found the right entry vector yet. I will prob try talking to the maintainer directly and see what their thoughts are.

(on a separate note, maybe mine and @uncomfyhalomacro knowledge bases can be added to prg-roam's md) A bigger project I would like to take on is an ocaml parser program for org-roam file directories, which would make it emacs independent, and that could also have functionalities for building a website based off of it.

wylited avatar Apr 06 '24 13:04 wylited