Jekyll TOC 插件使用教程

项目介绍

Jekyll TOC 是一个用于生成目录（Table of Contents, TOC）的 Jekyll 插件。它可以帮助你在不使用 JavaScript 的情况下，为你的 Jekyll 博客或网站生成目录。这个插件特别适用于 GitHub Pages，因为 GitHub Pages 不支持自定义 Jekyll 插件。

项目快速启动

安装

1. 将以下代码添加到你的 Jekyll 项目的 _config.yml 文件中：

   gems:
     - jekyll-toc
   

2. 在你的布局文件（如 _layouts/post.html）中添加以下代码以生成目录：

   {% if page.toc %}
     <div class="toc">
       {{ content | toc_only }}
     </div>
   {% endif %}
   {{ content | inject_anchors }}
   

使用

在你的 Markdown 文件中，添加 toc: true 到 YAML 头部：

---
layout: post
title: 示例文章
toc: true
---

## 标题1

### 子标题1.1

### 子标题1.2

## 标题2

### 子标题2.1

### 子标题2.2

应用案例和最佳实践

应用案例

• 个人博客：在个人博客中使用 Jekyll TOC 插件，可以帮助读者快速导航到感兴趣的部分。
• 技术文档：在技术文档网站中使用 Jekyll TOC 插件，可以提高文档的可读性和导航性。

最佳实践

• 保持简洁：确保目录只包含主要的标题，避免过多的子标题，以免目录过于冗长。
• 样式优化：为目录添加自定义样式，使其与你的网站风格保持一致。

典型生态项目

• Jekyll：Jekyll 是一个静态站点生成器，广泛用于构建博客和文档网站。
• GitHub Pages：GitHub Pages 是一个静态站点托管服务，与 Jekyll 集成良好，适合托管个人、组织或项目的页面。

通过以上步骤，你可以轻松地在你的 Jekyll 项目中集成 Jekyll TOC 插件，提升网站的用户体验。