hexo-toc 项目常见问题解决方案

hexo-toc 项目常见问题解决方案

hexo-toc 📖 Insert a markdown TOC before posts be rendered. 项目地址: https://gitcode.com/gh_mirrors/he/hexo-toc

1. 项目基础介绍和主要编程语言

hexo-toc 是一个为 Hexo 博客框架设计的插件，它可以在文章渲染之前插入一个 Markdown 格式的目录（TOC）。这个插件不同于 Hexo 内置的 TOC 功能，它只在源 Markdown 文件中找到特定的占位符 <-- toc --> 时才插入目录。用户只需在需要的地方放置这个占位符即可。项目的主要编程语言是 JavaScript。

2. 新手常见问题及解决步骤

问题一：如何安装 hexo-toc 插件？

解决步骤：

1. 确保你的博客项目已经安装了 Hexo。

2. 打开终端，进入到你的 Hexo 项目目录。

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

   npm install hexo-toc --save
   

4. 安装完成后，修改 _config.yml 文件，在配置文件中添加或修改 toc 配置项。

问题二：如何配置 hexo-toc 插件？

解决步骤：

1. 在 Hexo 项目的 _config.yml 文件中找到 toc 配置部分。

2. 根据需要修改配置，例如：

   toc:
     maxdepth: 3
     class: toc
     slugify: transliteration
     decodeEntities: false
     anchor:
       position: after
       symbol: '#'
       style: header-anchor
   

3. 保存 _config.yml 文件，并重新生成和部署你的 Hexo 博客。

问题三：为什么我的文章中没有显示目录？

解决步骤：

1. 确保在文章的 Markdown 文件中插入了 <-- toc --> 占位符。
2. 检查 _config.yml 文件中的 toc 配置是否正确设置。
3. 如果你的 Hexo 主题已经内置了 TOC 功能，请确保没有冲突的插件或配置。
4. 重新生成和部署你的 Hexo 博客，查看问题是否解决。

如果上述步骤仍然无法解决问题，可以检查项目的 GitHub Issues 来查找是否有类似的问题或解决方案，或者创建一个新的 Issue 来寻求帮助。注意，不要在 Issue 中包含个人项目的链接，以保护你的隐私。

hexo-toc 📖 Insert a markdown TOC before posts be rendered. 项目地址: https://gitcode.com/gh_mirrors/he/hexo-toc