Remarkable to Obsidian Sync

This project syncs but most important converts your remarkable drawings to Excalidraw / markdown files that can be used in combination with the Obsidian Excalidraw Plugin.

Report Bug Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact
7. Acknowledgments

About The Project

(back to top)

Built With

• 
• 

(back to top)

Getting Started

The usage is pretty straight forward. There are some dependencies, see the Dockerfile if you want to know more.

Prerequisites

You need to have Docker if you want use this script the same way as I do. How to get Docker is explained on the Docker website.

Installation

1. Make sure you have something to copy the files from the remarkable to your machine. I use Rsync which comes with MacOs and almost every Linux distribution.

2. Clone the repo

   git clone git@github.com:EelcovanVeldhuizen/remarkable-obsidian-sync.git

(back to top)

Usage

Sync your remarkables with RSYNC (or any other tool). This works the best if you have set-up passwordless login with the help of SSH keys. The best explenation how to do this I found this Reddit Post.

rsync -av root@10.11.99.1:/home/root/.local/share/remarkable/xochitl/ <path_to_remarkables>

I use Docker to create keep the python installtion on my machine clean.

To build build the container (which will be named ros):

docker build -t ros .

Run the container with the paths to your remarkable files and where you want the markdown files to end up.

docker run  -v <path_to_remarkables>:/app/remarkables:ro -v <path_to_dir_in_vault>:/app/vault ros

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

You can reach me on Github!

Project Link: https://github.com/EelcovanVeldhuizen/remarkable-obsidian-sync

(back to top)

Acknowledgments

• RMScene by Ricklupton
• RMC by Ricklupton
• Best README Template by Othneildrew

(back to top)