https://github.com/org-roam/org-roam-server

A Web Application to Visualize the Org-Roam Database
https://github.com/org-roam/org-roam-server

elisp emacs html javascript note-taking org-mode org-roam web-application

Last synced: 20 days ago
JSON representation

A Web Application to Visualize the Org-Roam Database

• Host: GitHub
• URL: https://github.com/org-roam/org-roam-server
• Owner: org-roam
• License: mit
• Created: 2020-04-29T20:51:04.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-01T15:54:16.000Z (almost 3 years ago)
• Last Synced: 2024-05-02T02:52:42.750Z (2 months ago)
• Topics: elisp, emacs, html, javascript, note-taking, org-mode, org-roam, web-application
• Language: HTML
• Homepage:
• Size: 38.6 MB
• Stars: 633
• Watchers: 28
• Forks: 54
• Open Issues: 43
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome - org-roam-server - A Web Application to Visualize the Org-Roam Database (HTML)
• awesome-stars - org-roam/org-roam-server - A Web Application to Visualize the Org-Roam Database (HTML)

README

        
org-roam-server

===================================

![License](https://img.shields.io/github/license/org-roam/org-roam-server)

![Release](https://img.shields.io/github/v/release/org-roam/org-roam-server)

[![MELPA](https://melpa.org/packages/org-roam-server-badge.svg)](https://melpa.org/#/org-roam-server)

![Graph](https://raw.githubusercontent.com/goktug97/org-roam-server/master/org-roam-server.gif)

## Org Roam v2

For `org-roam v2`, use

[org-roam-ui](https://github.com/org-roam/org-roam-ui), `org-roam-server`

only works with `org-roam v1`

## Installation

`org-roam-server` is on MELPA. You can directly install from there.

```elisp

(use-package org-roam-server

  :ensure t

  :config

  (setq org-roam-server-host "127.0.0.1"

        org-roam-server-port 8080

        org-roam-server-authenticate nil

        org-roam-server-export-inline-images t

        org-roam-server-serve-files nil

        org-roam-server-served-file-extensions '("pdf" "mp4" "ogv")

        org-roam-server-network-poll t

        org-roam-server-network-arrows nil

        org-roam-server-network-label-truncate t

        org-roam-server-network-label-truncate-length 60

        org-roam-server-network-label-wrap-length 20))

```

## Usage

Use `M-x org-roam-server-mode RET` to enable the global mode. 

It will start a web server on http://127.0.0.1:8080/.

Although it will automatically reload if there is a change in the

database, sometimes it fails to establish a connection. If it does not

reload after `org-roam-build-cache`, you can do it manually by

clicking the `reload` button which will reload the data, rebuild the

graph and refresh connections.

## Org-Roam Protocol

The graph utilizes org-roam protocol which means if you click on one

of the nodes, it will open the corresponding file in Emacs. For this

feature to work, org-roam protocol should be configured in the system.

[Configuring Org-Roam Protocol](https://www.orgroam.com/manual.html#Installation-_00281_0029)

Also make sure the emacs server is started; `M-x server-start RET`

## License

org-roam-server is licensed under the MIT License.

For Javascript and CSS libraries please refer to;

- https://github.com/jquery/jquery/blob/master/LICENSE.txt

- https://github.com/visjs/vis-network

- https://github.com/twbs/bootstrap/blob/master/LICENSE

- https://github.com/gongzhitaao/orgcss

- https://github.com/select2/select2

- https://github.com/minhur/bootstrap-toggle/blob/master/LICENSE