Jekyll-TOC 项目使用教程

Jekyll-TOC 项目使用教程

jekyll-tocJekyll plugin which generates a table of contents.项目地址:https://gitcode.com/gh_mirrors/jek/jekyll-toc

1. 项目的目录结构及介绍

jekyll-toc/
├── _includes/
│   └── toc.html
├── _tests/
│   └── toc_test.rb
├── .gitattributes
├── .gitignore
├── .gitmodules
├── CONTRIBUTING.md
├── Gemfile
├── LICENSE
├── README.md
├── _config.yml
└── jekyll-toc.gemspec

• _includes/: 包含用于生成目录的 toc.html 文件。
• _tests/: 包含项目的测试文件 toc_test.rb。
• .gitattributes, .gitignore, .gitmodules: Git 配置文件。
• CONTRIBUTING.md: 贡献指南。
• Gemfile: 项目依赖文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• _config.yml: Jekyll 配置文件。
• jekyll-toc.gemspec: 项目 gem 规范文件。

2. 项目的启动文件介绍

项目的启动文件主要是 _includes/toc.html，它负责生成页面的目录结构。该文件通过 Liquid 模板语言解析 Markdown 文档的标题，并生成相应的目录。

3. 项目的配置文件介绍

• _config.yml: 这是 Jekyll 的主要配置文件，用于配置站点的各种参数。在使用 jekyll-toc 时，通常不需要额外配置，但如果需要自定义目录的生成方式，可以在此文件中进行相应设置。
• jekyll-toc.gemspec: 这个文件定义了 gem 的元数据，包括名称、版本、依赖等信息。它是在发布 gem 时使用的。

以上是基于 https://github.com/toshimaru/jekyll-toc.git 项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些信息能帮助你更好地理解和使用该项目。

jekyll-tocJekyll plugin which generates a table of contents.项目地址:https://gitcode.com/gh_mirrors/jek/jekyll-toc