{"id":14008271,"url":"https://github.com/AloisJanicek/org-roam-server-light","last_synced_at":"2025-07-24T03:32:22.058Z","repository":{"id":219553779,"uuid":"276744958","full_name":"AloisJanicek/org-roam-server-light","owner":"AloisJanicek","description":"compatible org-roam-server written in python for better performance with large network graphs","archived":true,"fork":false,"pushed_at":"2021-08-04T23:27:05.000Z","size":3333,"stargazers_count":26,"open_issues_count":0,"forks_count":2,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-08-10T11:02:51.219Z","etag":null,"topics":["elisp","emacs","mind-mapping","note-taking","org-mode","org-roam","second-brain","visualization"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AloisJanicek.png","metadata":{"files":{"readme":"README.org","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-07-02T21:03:52.000Z","updated_at":"2024-08-10T11:02:53.403Z","dependencies_parsed_at":null,"dependency_job_id":"f836ac24-ccd6-4631-9abf-aa4464d3ca57","html_url":"https://github.com/AloisJanicek/org-roam-server-light","commit_stats":null,"previous_names":["aloisjanicek/org-roam-server-light"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AloisJanicek%2Forg-roam-server-light","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AloisJanicek%2Forg-roam-server-light/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AloisJanicek%2Forg-roam-server-light/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AloisJanicek%2Forg-roam-server-light/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AloisJanicek","download_url":"https://codeload.github.com/AloisJanicek/org-roam-server-light/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227410553,"owners_count":17774767,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elisp","emacs","mind-mapping","note-taking","org-mode","org-roam","second-brain","visualization"],"created_at":"2024-08-10T11:01:31.668Z","updated_at":"2024-11-30T19:30:55.181Z","avatar_url":"https://github.com/AloisJanicek.png","language":"HTML","funding_links":[],"categories":["HTML"],"sub_categories":[],"readme":"#+TITLE: Readme\n\n* org-roam-server-light\n** Org-roam v2\nFor the =org-roam v2= use [[https://github.com/org-roam/org-roam-ui][org-roam-ui]] instead.\n=org-roam-server-light= only works with =org-roam v1= and will not be actively maintained.\n----------------------------------------------------------------------------------------------------\n\nThis project is NOT part of official [[https://www.orgroam.com/][Org-roam]] project.\nThis project started as personal experiment, proof-of-concept and doesn't aspire to become something more then that.\nIt however uses \"org-roam(-server)\" name but does it out of good intentions:\n1. to make this little experiment easier to find\n2. to make the purpose of this project clear\n\n=org-roam-server-light= attempts to move [[https://github.com/org-roam/org-roam-server][org-roam-server]] functionality from emacs into external python server process due to subjective poor elisp / emacs performance when computing graph data for larger amount of org-roam files and serving them to web browser.\n\n** Credits\nClient side code, assets and some elisp copied as they are from [[https://github.com/org-roam/org-roam-server][org-roam-server]],\npython code copied and expanded from [[https://github.com/aklatzke/python-webserver-part-2][aklatzke/python-webserver-part-2]]\n\n** Prerequisites\nFile-preview functionality requires [[https://pandoc.org/][pandoc]] being available in your PATH\n\n** Installation\n#+BEGIN_EXAMPLE\ngit clone https://github.com/AloisJanicek/org-roam-server-light.git\n#+END_EXAMPLE\n\nDepending on your emacs use one of the following snippets to install and configure =org-roam-server-light=.\n\n** Elisp code\nif you are using doom emacs\n\n#+BEGIN_SRC emacs-lisp\n;; .doom.d/packages.el\n\n(package! org-roam-server-light\n  :recipe (:host github :repo \"AloisJanicek/org-roam-server-light\"\n           :files (\"*\")))\n#+END_SRC\n\n#+BEGIN_SRC emacs-lisp\n;; .doom.d/config.el\n\n(use-package! org-roam-server-light\n  :after org-roam\n  :commands org-roam-server-light-mode\n  :config\n  ;; OPTIONAL example settings, `org-roam-server-light' will work without them\n  (setq\n   ;; enable arrows\n   org-roam-server-light-network-vis-options \"{ \\\"edges\\\": { \\\"arrows\\\": { \\\"to\\\": { \\\"enabled\\\": true,\\\"scaleFactor\\\": 1.15 } } } }\"\n\n   ;; change background color of web application\n   org-roam-server-light-style \"body.darkmode { background-color: #121212!important; }\"\n\n   ;; set default set of excluded or included tags\n   ;; customize only the value of id, in this case \"test\" and \"journal\"\n   org-roam-server-light-default-include-filters \"[{ \\\"id\\\": \\\"test\\\", \\\"parent\\\" : \\\"tags\\\"  }]\"\n   org-roam-server-light-default-exclude-filters \"[{ \\\"id\\\": \\\"journal\\\", \\\"parent\\\" : \\\"tags\\\"  }]\"\n   )\n  )\n#+END_SRC\n\nif you are using other emacs with use-package\n\n#+BEGIN_SRC emacs-lisp\n;; .emacs.d/init.el\n\n(use-package org-roam-server-light\n  ;; MANDATORY: path to your local copy of this repository\n  :load-path \"/home/john/where-i-cloned-this\"\n  :after org-roam\n  :commands org-roam-server-light-mode\n  :config\n  ;; OPTIONAL example settings, `org-roam-server-light' will work without them\n  (setq\n   ;; enable arrows\n   org-roam-server-light-network-vis-options \"{ \\\"edges\\\": { \\\"arrows\\\": { \\\"to\\\": { \\\"enabled\\\": true,\\\"scaleFactor\\\": 1.15 } } } }\"\n\n   ;; change background color of web application\n   org-roam-server-light-style \"body.darkmode { background-color: #121212!important; }\"\n\n   ;; set default set of excluded or included tags\n   ;; customize only the value of id, in this case \"test\" and \"journal\"\n   org-roam-server-light-default-include-filters \"[{ \\\"id\\\": \\\"test\\\", \\\"parent\\\" : \\\"tags\\\"  }]\"\n   org-roam-server-light-default-exclude-filters \"[{ \\\"id\\\": \\\"journal\\\", \\\"parent\\\" : \\\"tags\\\"  }]\"\n   )\n  )\n#+END_SRC\n\nor in other emacs\n\n#+BEGIN_SRC emacs-lisp\n;; .emacs.d/init.el\n\n(eval-after-load 'org-roam\n  ;; OPTIONAL: customize some settings or leave them to their defaults\n  ;; enable arrows\n  (setq org-roam-server-light-network-vis-options \"{ \\\"edges\\\": { \\\"arrows\\\": { \\\"to\\\": { \\\"enabled\\\": true,\\\"scaleFactor\\\": 1.5 } } } }\"\n\n        ;; OPTIONAL example: change background color of web application\n        org-roam-server-light-style \"body.darkmode { background-color: #121212!important; }\"\n\n        ;; OPTIONAL example: set default set of excluded or included tags\n        ;; customize only the value of id, in this case \"test\" and \"journal\"\n        org-roam-server-light-default-include-filters \"[{ \\\"id\\\": \\\"test\\\", \\\"parent\\\" : \\\"tags\\\"  }]\"\n        org-roam-server-light-default-exclude-filters \"[{ \\\"id\\\": \\\"journal\\\", \\\"parent\\\" : \\\"tags\\\"  }]\"\n        )\n\n  ;; finally load the main `org-roam-server-light' elisp file\n  (load (expand-file-name \"org-roam-server-light.el\" \"/home/john/where-i-cloned-this\"))\n  )\n#+END_SRC\n\n** Usage\nRunning =org-roam-server-light-mode= will start org-roam-server-light server on http://localhost:8080\n\n** TODO Roadmap and functionality overview [8/19]\n- [X] start/stop python web-server when enable/disable major mode in emacs\n- [X] build and serve JSON data based on =org-roam.db= for vis.Network\n- [X] org-roam-buffer sidepane (basic)\n- [ ] improve org-roam-buffer sidepane\n  - add total count of backlinks\n- [X] keep track of current buffer\n- [X] file previews (basic)\n- [ ] improve file previews\n  - add CREATED timestamp (?)\n- [ ] serve (certain) files linked from exported files\n- [ ] serve inline images\n- [ ] mark last captured file as current buffer\n- [ ] handle citation backlinks in org-roam-buffer sidepane\n- [X] serve custom JSON config for vis.Network\n  =org-roam-server-light-network-vis-options=\n- [ ] ability to customize server url/port via elisp variable\n- [X] ability to customize CSS for web app via elisp variable\n- [ ] ability to customize CSS for exported files via elisp-variable\n- [X] filter items by org-roam tag in web app and ability to set default whitelist/blacklist\n  =org-roam-server-light-default-include-filters=\n  =org-roam-server-light-default-exclude-filters=\n- [ ] review path handling in python code\n- [ ] review exported files encoding issues on Windows (cp-1252 vs utf-8 weirdness)\n- [ ] review mechanism of sharing data between emacs and python web-server\n  currently emacs writes data as text to plain-text files for python web-server to read it\n\n** Licence\norg-roam-server-light is licensed under the MIT License.\n\nLicence of python part of the code is unclear because there is no licence specified in [[https://github.com/aklatzke/python-webserver-part-2][aklatzke/python-webserver-part-2]], which is where the python code originates.\n\nFor Javascript and CSS libraries please refer to;\n\n- https://github.com/jquery/jquery/blob/master/LICENSE.txt\n- https://github.com/visjs/vis-network\n- https://github.com/twbs/bootstrap/blob/master/LICENSE\n- https://github.com/gongzhitaao/orgcss\n- https://github.com/select2/select2\n- https://github.com/minhur/bootstrap-toggle/blob/master/LICENSE\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAloisJanicek%2Forg-roam-server-light","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAloisJanicek%2Forg-roam-server-light","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAloisJanicek%2Forg-roam-server-light/lists"}