Sincronizando Org-Roam mediante Github en Emacs

Está muy bien tener una base de conocimiento centralizada en una carpeta y gestionarla mediante Org-Roam pero mejor aun está poder acceder y modificar esta carpeta desde varios equipos gracias a un repositorio de Github.

Desde hace un tiempo, he intentado varias veces crear con mis notas una base de conocimiento en Emacs mediante Org-Roam pero la primera rampa de la curva de aprendizaje me había resultado muy dura y lo había dejado de lado todas las veces. Al fin creo que lo he conseguido.

Crear el repositorio

Una de las principales características que debe tener esta base de conocimiento es que sea accesible por cualquiera y desde cualquier lugar por lo que el primer paso es crear un repositorio público en Github. En mi caso lo he llamado “org-roam”

Copiar la llave ssh

Para poder editar desde nuestro equipo el repositorio que hemos creado en Github necesitamos subir al servidor nuestra llave pública. Consiste copiar el contenido del archivo “/home/sherlockes/.ssh/id_rsa.pub” y añadirlo como una “SSH key” dentro del apartado “SSH and GPG keys” de la configuración de nuestra cuenta de Github

En caso de que no exista el archivo “id_rsa.pub” en nuestro archivo generaremos una nueva llave con el comando ssh-keygen.

Este paso es imprescindible ya que Github no permite la modificación de un repositorio desde la consola de un equipo remoto a través de la identificación mediante usuario y contraseña.

Clonar en repositorio en nuestro equipo

Ahora toca clonar el repositorio, nos ubicaremos en la ruta donde queremos que se cree la carpeta clonada y ejecutaremos el siguiente comando.

git clone git@github.com:tu_usuario/tu_repo.git

Es imprescindible usar la ruta ssh para el clonado si no queremos tener problemas al actualizarlo de forma remota.

Actualizar el repositorio local

Ya tenemos el repositorio clonado, en mi caso ubicado en la ruta “~/org-roam” y ahora necesitamos que, al arrancar Emacs, compruebe si la carpeta “org-roam” existe en la ruta raíz del usuario. Si la carpeta existe, se actualizará el repositorio en ella. Si la carpeta no existe, se volverá a clonar en la raíz del usuario el repositorio de Github.

Para esto incluimos el siguiente código en el archivo de configuración de Emacs “init.el”.

(if (file-exists-p "~/org-roam/")
    (let ((default-directory "~/org-roam"))(shell-command "git pull"))
  (let ((default-directory "~/"))(shell-command "git clone git@github.com:sherlockes/org-roam.git"))
)

Modificar el repositorio remoto

Para conseguir que el repositorio remoto se sincronice tras modificar algún archivo de nuestro repositorio clonado localmente usaremos un “hook” que se lance cuando se guarda un archivo y una función auxiliar que simplemente comprueba si el archivo que se ha modificado está dentro de la carpeta “org-roam”. En caso de que se de la condición, se ejecutará otra función que actualiza el repositorio.

  (defun org-roam-update()
    (interactive)

	(let ((default-directory "~/org-roam")) 
	    (shell-command "git add --all")
	    (shell-command "git commit -m 'Update'")
	    (shell-command "git push")
	)
    )
  (defun funcion-al-guardar ()
    (let ((directorio-org-roam (expand-file-name "org-roam" (getenv "HOME"))))
      (when (string-prefix-p directorio-org-roam buffer-file-name)
	(org-roam-update))))

  (add-hook 'after-save-hook 'funcion-al-guardar)

Y ya está, a partir de ahora, cada vez que modifiquemos un archivo de nuestra base de conocimiento se actualizará el repositorio remoto de la misma.