在没有版本控制的情况下提供 RMarkdown 输出

如何解决在没有版本控制的情况下提供 RMarkdown 输出

我们经常使用基于 RMarkdown 的包来创建带有 R (bookdown,blogdown,distill...) 的网站，并使用 github-pages 通过 url { {1}}。

在这种方法中，输出（即 html / css）文件也受版本控制，并且经常错误地包含在提交中 (username.github.io/repo)。这很烦人，因为这些文件会使提交变得混乱，并且经常导致虚构的文件冲突。

理想情况下，输出文件根本不受版本控制，因为二进制文件（图像）还会使存储库膨胀。所以我正在寻找一个解决方案：

• Git 会完全忽略输出文件，但为 gh-pages 提供了一种替代（但具有可比性¹）的方法来为它们提供服务
• Git 暂时忽略输出文件，并将它们提交/推送到 gh-pages 是在单独的显式命令中完成的

¹：该方法应该基于命令行并提供一个很好的 URL 来访问网站

解决方法

您可以在 .html 和所有其他分支中忽略 .css、main 等，但分支除外，例如 gh-page 分支，您的 github-页面是从构建的。

Git 不支持不同分支中的不同 .ignore 文件，因此您必须设置一个 bash 脚本，以便在每次检出新分支时替换忽略文件。请参阅此处了解如何执行此操作：https://gist.github.com/wizioo/c89847c7894ede628071

也许不是您希望的优雅解决方案，但它应该有效。

,

如果您的计算机上安装了 python，则可以使用 GitHub Pages Import，这是专门为此目的而设计的工具。

您需要安装 python，因为它必须与 pip 一起安装，但是一旦安装，它就会与 R/RMarkdown 工作流完美集成。

安装后 (pip install ghp-import)，您可以运行 ghp-import docs（假设 docs 是您的 RMarkdown 输出的存储位置）。

您可以使用许多实用选项，包括 -p 在提交后将更改额外推送到您的遥控器。

,

您需要告诉 Git 忽略该书所在的文件夹。

因此，例如，默认情况下，bookdown 将所有构建的文件放在名为“_book”的文件夹中

只需将以下行添加到项目中的 .gitignore 文件即可。

_book

然后您就可以处理您的书并构建它并推送更改，而无需担心网站是否更新。

要更新站点，您需要创建一个仅用于托管内容的 gh-pages 分支。使用书籍文件夹中的这些命令执行此操作：

git checkout --orphan gh-pages
git rm -rf .

# create a hidden file .nojekyll
touch .nojekyll
git add .nojekyll

git commit -m"Initial commit"
git push origin gh-pages

确保（一旦您将图书内容放在该分支中）GitHub 设置为使用该分支进行托管，而不是您之前使用的文件夹。

然后，您可以使用以下命令切换回主分支：

git checkout master

接下来，您将把 gh-pages 分支克隆到您的主项目中：

git clone -b gh-pages https://github.com/yourprojecturl.git book-output

然后，当您准备好将构建的书籍版本（在 _book 文件夹中）用作实时站点时，使用以下命令将内容复制到 book-output 文件夹并将其推送到 gh-pages现场站点所在的分支：

cd book-output
git rm -rf *
cp -r ../_book/* ./
git add --all *
git commit -m"Update the book"
git push -q origin gh-pages

只要您在 _book 中有准备实时推送的版本，您就可以继续使用最后一组命令。