Roam-to-Git 项目使用指南

Roam-to-Git 项目使用指南

roam-to-git Automatic RoamResearch backup to Git 项目地址: https://gitcode.com/gh_mirrors/ro/roam-to-git

1. 项目介绍

Roam-to-Git 是一个用于自动备份 RoamResearch 工作区的开源项目。它能够将你的 RoamResearch 图表自动下载为 Markdown 和 JSON 格式，并将这些文件备份到 Git 仓库中。通过这种方式，你可以确保你的笔记数据安全，并且可以随时查看历史版本。

主要功能

• 自动下载 RoamResearch 工作区的 Markdown 和 JSON 备份。
• 下载完整的 EDN 格式的 RoamResearch 工作区。
• 格式化 Markdown 文件，包括添加反向链接。
• 将差异提交并推送到 GitHub。

2. 项目快速启动

2.1 安装依赖

首先，确保你已经安装了 Python 和 Git。然后，通过以下命令安装 Roam-to-Git：

pip install git+https://github.com/MatthieuBizien/roam-to-git.git

2.2 配置 GitHub 仓库

1. 创建一个新的 GitHub 仓库用于存储你的 RoamResearch 备份。
2. 配置 GitHub Secrets，添加以下三个环境变量：
   • ROAMRESEARCH_USER
   • ROAMRESEARCH_PASSWORD
   • ROAMRESEARCH_DATABASE

2.3 设置 GitHub Actions

在你的 GitHub 仓库中，创建一个 .github/workflows/main.yml 文件，内容如下：

name: Roam-to-Git Backup
on:
  schedule:
    - cron: '0 * * * *'  # 每小时运行一次
  workflow_dispatch:

jobs:
  backup:
    runs-on: ubuntu-latest
    steps:
    - name: Checkout repository
      uses: actions/checkout@v2
    - name: Set up Python
      uses: actions/setup-python@v2
      with:
        python-version: '3.8'
    - name: Install dependencies
      run: |
        python -m pip install --upgrade pip
        pip install git+https://github.com/MatthieuBizien/roam-to-git.git
    - name: Run Roam-to-Git
      env:
        ROAMRESEARCH_USER: ${{ secrets.ROAMRESEARCH_USER }}
        ROAMRESEARCH_PASSWORD: ${{ secrets.ROAMRESEARCH_PASSWORD }}
        ROAMRESEARCH_DATABASE: ${{ secrets.ROAMRESEARCH_DATABASE }}
      run: roam-to-git

2.4 运行备份

提交并推送你的更改，GitHub Actions 将自动开始备份你的 RoamResearch 工作区。

3. 应用案例和最佳实践

3.1 定期备份

通过设置 GitHub Actions 的定时任务，你可以确保你的 RoamResearch 工作区每小时自动备份一次。这样，即使 RoamResearch 出现数据丢失，你也可以从备份中恢复。

3.2 版本控制

使用 Git 进行备份，你可以轻松查看笔记的历史版本，并进行版本回滚。这对于长期维护和管理的笔记非常有用。

3.3 移动设备访问

由于备份存储在 GitHub 上，你可以通过移动设备轻松访问和管理你的笔记。GitHub 提供了移动应用，方便你在任何地方查看和编辑你的笔记。

4. 典型生态项目

4.1 RoamResearch

RoamResearch 是一个强大的笔记工具，特别适合进行知识管理和链接思维。Roam-to-Git 项目正是为了解决 RoamResearch 数据备份的问题而开发的。

4.2 GitHub Actions

GitHub Actions 是一个自动化工具，可以帮助你自动执行各种任务，如代码测试、部署和数据备份。通过结合 Roam-to-Git 和 GitHub Actions，你可以实现自动化的笔记备份。

4.3 GitLab CI

除了 GitHub Actions，你还可以使用 GitLab CI 来实现自动备份。GitLab CI 提供了类似的功能，并且可以与 GitLab 的私有仓库结合使用，适合需要更高安全性的用户。

通过以上步骤，你可以轻松地将 RoamResearch 的笔记数据备份到 Git 仓库中，并实现自动化的版本控制和数据管理。

roam-to-git Automatic RoamResearch backup to Git 项目地址: https://gitcode.com/gh_mirrors/ro/roam-to-git