用 Jekyll 和 Git 展示你的源码

时间:2022-06-01 20:59:01

用 Jekyll 和 Git 展示你的源码

我是如何通过链接每个页面回到其原始源代码来保持我的网站开放的。

我是一个开源的超级粉丝。

我支持这项事业的一个小方法是从一开始就保持我的个人博客网站开放。我这样做的部分原因是让人们看到每个页面背后的变化历史。还因为当我开始使用 Jekyll 时,我没有找到很多开源的 Jekyll 博客可以学习。我希望保持我的网站开放并公开我的尝试和错误,可以为其他人节省很多时间。

Jekyll 的 page.path 变量

我实现这一目标的方法之一是将我发布的每一个条目链接到其原始的 Markdown。Jekyll 的变量 中正好有一个需要的工具:page.path。这个变量包含每个页面的原始文件系统路径。官方的描述甚至强调了它的作用是链接回源!

在一篇文章的 Markdown 文件中打印 {{page.path }},可以得到类似这样的结果:

  1. _posts/2021-10-10-example.md

假设该文章的源代码存在于这个路径:

  1. https://example.com/ayushsharma-in/-/blob/master/_posts/2021-10-10-example.md

如果你在任何文章的 page.path 前加上 https://example.com/ayushsharma-in/-/blob/master/,它就会生成一个返回其源码的链接。

在 Jekyll 中,生成这个完整的链接看起来像这样:

  1. <a href="{{ page.path | prepend: site.content.blog_source_prefix }}" target="_blank">View source</a>

就是这么简单。

Jekyll 和开放 Web

现代 Web 是一种错综复杂的多层次技术,但这并不意味着它必须让人摸不清。有了 Jekyll 的变量,你可以确保你的用户可以,了解更多关于你是如何建立你的网站的,如果他们愿意的话。

你可以在我的个人博客上看到真实的例子:滚动到底部的查看源码链接。

原文链接:https://linux.cn/article-14091-1.html