{"id":13783631,"url":"https://github.com/llcc/org-logseq","last_synced_at":"2025-05-11T19:31:13.842Z","repository":{"id":44336538,"uuid":"352059183","full_name":"llcc/org-logseq","owner":"llcc","description":"Org-logseq allows you to open logseq-style page and block link along with Org Mode.","archived":false,"fork":false,"pushed_at":"2023-09-20T02:49:59.000Z","size":36,"stargazers_count":103,"open_issues_count":4,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-17T20:47:35.471Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/llcc.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}},"created_at":"2021-03-27T11:47:20.000Z","updated_at":"2024-11-08T12:09:31.000Z","dependencies_parsed_at":"2024-01-07T00:07:46.452Z","dependency_job_id":null,"html_url":"https://github.com/llcc/org-logseq","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/llcc%2Forg-logseq","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/llcc%2Forg-logseq/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/llcc%2Forg-logseq/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/llcc%2Forg-logseq/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/llcc","download_url":"https://codeload.github.com/llcc/org-logseq/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253621023,"owners_count":21937465,"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":[],"created_at":"2024-08-03T19:00:27.006Z","updated_at":"2025-05-11T19:31:13.565Z","avatar_url":"https://github.com/llcc.png","language":"Emacs Lisp","readme":"#+TITLE:Org-logseq\n\nOrg-logseq supports to open [[https://github.com/logseq/logseq][logseq]]-style link (page or block reference), transclusion of referred and embedded blocks using overlays, along with Org-Mode.\n\n* Features\n\n+ Open logseq-style links by native Org-Mode binding (=C-c C-o=, =Enter=, etc). Org-logseq supports:\n  - Page link: =[[a logseq page]]=\n  - Block reference: =((6064f6c6-440a-46ca-b8df-59131adab5a1))=\n  - Block Embed and Reference overlays.\n+ Create a blank excalidraw file if necessary, while inserting it at point.\n+ Display logseq block references in buffer as overlays:\n  - =((6064f6c6-440a-46ca-b8df-59131adab5a1))= to =[[id:6064f6c6-440a-46ca-b8df-59131adab5a1][Block heading]]=\n  - ={{embed  ((6064f6c6-440a-46ca-b8df-59131adab5a1))}}= to the content of the referred block.\n+ Download images stored in the logseq server to local.\n  =curl= needs to be installed first.\n+ Toggle =contents.org= as a sidebar.\n\n* Installation\n\nOrg-logseq requires =grep=. Install it using your system tool at first. \n\nOrg-logseq package is not on MELPA yet. Currently, the easiest way to install org-logseq is through [[https://github.com/quelpa/quelpa][quelpa]] or [[https://github.com/raxod502/straight.el][straight]] system, or use the =:quelpa= or =:straight= keyword by using [[https://github.com/jwiegley/use-package][use-package]]. In order to make =:quelpa= work well with =use-package=, you need to install [[https://github.com/quelpa/quelpa-use-package][quelpa-use-package]]. \n\n- quelpa\n  #+begin_src emacs-lisp\n  (use-package org-logseq\n    :quelpa (org-logseq :fetcher github :repo \"llcc/org-logseq\" :files (\"*\"))\n    :custom (org-logseq-dir \"~/logseq\"))\n  #+end_src\n\n- straight\n  #+begin_src emacs-lisp :tangle yes\n  (use-package org-logseq\n      :straight (org-logseq :fetcher github :repo \"llcc/org-logseq\" :files (\"*\"))\n      :custom (org-logseq-dir \"~/logseq\"))\n  #+end_src  \n  \n* Getting started\n\n1. Set the variable =org-logseq-dir= to your logseq path.\n2. =M-x org-logseq-mode= in your current buffer.\n   Creating a directory-local varible in your logseq directory could be the best way to get it worked in all org files.\n   \n   #+begin_src emacs-lisp\n   ((org-mode . ((eval org-logseq-mode 1))))\n   #+end_src\n   \n3. Use your native Org-mode bindings to open pages or block references.\n   \n* Customization\n\n- =org-logseq-create-page-p= ::\n  A boolean value indicating whether or not org-logseq should try to new a page file at point if it does not exist. The varible defaults to =nil=.\n- *org-logseq-block-ref-overlay-p* ::\n  A boolean value indicating whether or not to display the overlays of =block references= when initializing the Org-Mode buffer. \n- *org-logseq-block-embed-overlay-p* ::\n  A boolean value indicating whether or not to display the overlays of =block embed= when initializing the Org-Mode buffer. \n\n  \n* Changelog\n\n** \u003c2021-04-08 Thu\u003e\n- Add a =org-logseq-toggle-contents-sidebar= command, to toggle your =contents.org= as a sidebar.\n- Fix path quote bug in macOS, [[https://github.com/llcc/org-logseq/issues/1][#issue1]]\n   \n* Thanks\n\nAll to [[https://github.com/logseq/logseq][logseq]]. \n\n","funding_links":[],"categories":["💡 Workflows and Innovations"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fllcc%2Forg-logseq","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fllcc%2Forg-logseq","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fllcc%2Forg-logseq/lists"}