https://github.com/goshatch/orgroam_to_obsidian
Convert an org-roam notes collection to markdown for Obsidian
https://github.com/goshatch/orgroam_to_obsidian
markdown obsidian obsidian-md org-mode org-roam
Last synced: 5 months ago
JSON representation
Convert an org-roam notes collection to markdown for Obsidian
- Host: GitHub
- URL: https://github.com/goshatch/orgroam_to_obsidian
- Owner: goshatch
- Created: 2023-01-29T23:43:09.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T20:42:19.000Z (6 months ago)
- Last Synced: 2025-05-12T01:48:02.932Z (5 months ago)
- Topics: markdown, obsidian, obsidian-md, org-mode, org-roam
- Language: Ruby
- Homepage:
- Size: 17.6 KB
- Stars: 21
- Watchers: 2
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Convert org-roam files to Obsidian-ready markdown
This is a Ruby script that help converting a collection of notes created with [org-roam](https://www.orgroam.com/) to a bunch of Markdown files suitable for being imported into an [Obsidian](https://obsidian.md) 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
- [Pandoc](https://pandoc.org/)
- Ruby and bundler
## Running the conversion
## Preparation
```sh
$ 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
```sh
$ git clone https://github.com/goshatch/orgroam_to_obsidian
$ cd orgroam_to_obsidian
$ bundle install
$ ./convert.rb
```
#### Specifying the root org-roam directory
The script needs to know your root org-roam directory in order to correctly figure out the file names for each note. By default, it will use the org-roam default, which is `~/org-roam`. If you have changed this, get the value from emacs by inspecting the `org-roam-directory` variable, and pass it to the script with a command line flag:
```sh
$ ./convert.rb --roam-root "~/org/roam"
```
### Docker
```sh
$ 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](https://merveilles.town/@gosha), or to submit an issue to the repository.
If you encounter an issue, please run the script with the `--debug` flag for additional debug info, and include this in the issue.
Pull requests with improvements are very welcome.