Jekyll Relative Links 插件使用教程

Jekyll Relative Links 插件使用教程

jekyll-relative-linksA Jekyll plugin to convert relative links to markdown files to their rendered equivalents项目地址:https://gitcode.com/gh_mirrors/je/jekyll-relative-links

项目介绍

Jekyll Relative Links 是一个 Jekyll 插件，用于将 Markdown 文件中的相对链接转换为其渲染后的等效链接。这对于在 GitHub Pages 上托管的站点特别有用，因为它确保了链接的正确性。

项目快速启动

安装

1. 在你的 Jekyll 项目的 Gemfile 中添加以下内容：

   gem 'jekyll-relative-links'
   

2. 在你的 Jekyll 项目的 _config.yml 文件中添加以下内容：

   plugins:
     - jekyll-relative-links
   

3. 运行以下命令安装插件：

   bundle install
   

使用

在你的 Markdown 文件中，使用相对链接时，插件会自动将其转换为正确的 URL。例如：

[链接文本](相对路径.md)

应用案例和最佳实践

应用案例

假设你有一个 Jekyll 站点，其中包含多个 Markdown 文件。你希望在不同的页面之间创建内部链接。使用 Jekyll Relative Links 插件，你可以轻松实现这一点。

例如，假设你有两个文件 page1.md 和 page2.md，你可以在 page1.md 中添加以下链接：

[跳转到页面2](page2.md)

插件会自动将这个链接转换为正确的 URL，即使你的站点部署在子目录中。

最佳实践

• 始终使用相对链接：这样可以确保链接在不同的部署环境中都能正常工作。
• 避免硬编码 URL：使用插件可以减少手动调整 URL 的工作量。
• 测试链接：在部署前，确保所有链接都能正常工作。

典型生态项目

Jekyll Relative Links 插件是 Jekyll 生态系统中的一个重要组成部分。以下是一些相关的生态项目：

• Jekyll：一个静态站点生成器，支持 Markdown 和 Liquid 模板。
• GitHub Pages：一个免费的静态站点托管服务，支持 Jekyll 站点。
• Jekyll Plugins：一个包含多个 Jekyll 插件的集合，用于增强 Jekyll 的功能。

通过结合这些项目，你可以创建一个功能强大且易于维护的静态站点。

jekyll-relative-linksA Jekyll plugin to convert relative links to markdown files to their rendered equivalents项目地址:https://gitcode.com/gh_mirrors/je/jekyll-relative-links