Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 1.64 KB

README.md

File metadata and controls

52 lines (33 loc) · 1.64 KB
Raw

Convert org-roam files to Obsidian-ready markdown

This is a Ruby script that help converting a collection of notes created with org-roam to a bunch of Markdown files suitable for being imported into an Obsidian vault.

I hacked this together in a couple of evenings because I wanted to see if it made sense to start using Obsidian instead of Emacs for my note library.

Requirements

Running the conversion

Preparation

$ cp ~/.emacs.d/.local/cache/org-roam.db input/
$ cp -R ~/org/roam input/

The locations of org-roam.db and the roam directory above are provided as examples only. You can find the actual locations on your system by inspecting these variables in Emacs:

  • org-roam-db-location
  • org-roam-directory

Make sure to COPY these to your input directory, so that you have a backup in case things go wrong.

Next, you can either run it locally (you'll need Ruby and Pandoc) or via Docker.

Locally

$ git clone https://github.com/goshatch/orgroam_to_obsidian
$ cd orgroam_to_obsidian
$ bundle install
$ ./convert.rb

Docker

$ docker build -f $PWD/Dockerfile -t orgroam_to_obsidian:0.0.1 .
$ docker run -it --rm -v $PWD:/opt/orgroam-to-obsidian orgroam_to_obsidian:0.0.1

After the conversion is complete, the generated markdown files will be under the output directory.

Help and contributing

If you need any help with this, please feel free to reach out to me on Mastodon, or to submit an issue to the repository.

Pull requests with improvements are very welcome.