使用 Jinja2 和 Git 展示你的源代码

这是我如何通过将每个页面链接回其原始源代码来保持我的网站开放的。
10 位读者喜欢这篇文章。
Text editor on a browser, in blue

我是开源的忠实粉丝。

我支持开源的一个小方法是从一开始就保持我的个人博客网站开放。我这样做部分是为了让人们看到每个页面背后的更改历史。 但我也这样做是因为,当我开始使用 Jekyll 时,我没有找到很多开源 Jekyll 博客来学习。 我希望通过保持我的网站开放并暴露我的试验和错误,可以为其他人节省大量时间。

Jekyll page.path 变量

我实现这一目标的一种方法是将我发布的每个条目链接回其原始 MarkdownJekyll 的有用变量 提供了所需的工具:page.path。 此变量包含每个页面的原始文件系统路径。 官方描述甚至强调了它链接回源的用处!

在文章的 Markdown 文件中打印 {{ page.path }} 会输出类似于以下内容:

_posts/2021-10-10-example.md

假设该文章的源代码存在于此路径中

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

如果将 https://example.com/ayushsharma-in/-/blob/master/ 添加到任何文章的 page.path 前面,它会生成一个链接回其源代码的链接。

在 Jekyll 中,生成此完整链接如下所示:

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

就这么简单。

Jekyll 和开放网络

现代网络是一种复杂且多层的技术,但这并不意味着它必须模糊不清。 使用 Jekyll 的变量,您可以确保您的用户可以在需要时了解更多关于您如何构建网站的信息。

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


本文改编自 ayush sharma 的笔记,并经许可重新发布。

接下来读什么
标签
https://ayushsharma.in
我是一名作家和 AWS 解决方案架构师。 我与初创公司和企业合作,从事软件工程、DevOps、SRE 和云架构。 我在 https://ayushsharma.in 上写下我的经历。

评论已关闭。

Creative Commons License本作品采用知识共享署名-相同方式共享 4.0 国际许可协议进行许可。
© . All rights reserved.