summaryrefslogblamecommitdiffstats
path: root/2020/info/18.md
blob: 18e180c5495e3bd3fd0f7f5e1e71ce682fabb572 (plain) (tree)
1
2
3


                                  
































                                                                     
# Org-roam: Technical Presentation
Leo Vivier

Org-roam is a Roam replica built on top of the all-powerful Org-mode.

Org-roam is a solution for effortless non-hierarchical note-taking
with Org-mode.  With Org-roam, notes flow naturally, making
note-taking fun and easy.  Org-roam should also work as a
plug-and-play solution for anyone already using Org-mode for their
personal wiki.

Org-roam aims to implement the core features of Roam, leveraging the
mature ecosystem around Org-mode where possible.  Eventually, we hope
to further introduce features enabled by the Emacs ecosystem.

The purpose of the talk is to present some technical aspects of
Org-roam.  From the very beginning, we wanted Org-roam to scale with
your notes, and this meant that we had to keep a close eye on our
performances.  As we iterated, optimisation remained a top-priority,
leading us to constantly peek under Org-mode's hood.  Not only has
this made us better developers, but it has also uncovered paths of
optimisation for Org-mode itself.

The talk is targeted at software engineers willing to peek under
Org-mode's hood.  A rudimentary understanding of Elisp will be
required.

Points to be covered

-   SQL database via emacsql
-   Elisp libraries
-   Parsing of Org-mode files
-   org-elements.e
-   Parsing with a background-process
-   Ensuring consistency via hooks