markdown-it-toc-done-right 项目常见问题解决方案

markdown-it-toc-done-right 项目常见问题解决方案

markdown-it-toc-done-right A table of contents (TOC) plugin for Markdown-it with focus on semantic and security. Made to work gracefully with markdown-it-anchor. 项目地址: https://gitcode.com/gh_mirrors/ma/markdown-it-toc-done-right

1. 项目基础介绍

markdown-it-toc-done-right 是一个为 markdown-it 渲染器设计的表格目录（TOC）插件，专注于语义化和安全性。它能够与 markdown-it-anchor 插件无缝配合工作，生成可访问性良好、语义化的、对SEO友好的且安全的目录。在 Markdown 文档中插入特定的占位符即可自动生成目录。

主要编程语言：JavaScript

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

问题一：如何安装和使用 markdown-it-toc-done-right 插件？

解决步骤：

1. 使用 npm 安装 markdown-it-toc-done-right 和 markdown-it-anchor 插件：

   npm i -S markdown-it-toc-done-right markdown-it-anchor
   

2. 在你的 JavaScript 代码中引入 markdown-it、markdown-it-anchor 和 markdown-it-toc-done-right，然后使用它们：

   var md = require('markdown-it')({
       html: false,
       xhtmlOut: true,
       typographer: true
   });
   md.use(require('markdown-it-anchor'), {
       permalink: true,
       permalinkBefore: true,
       permalinkSymbol: '§'
   });
   md.use(require('markdown-it-toc-done-right'));
   

3. 使用 md.render() 方法渲染你的 Markdown 文本，其中包含 TOC 占位符：

   var result = md.render("# markdown-it rulezz\n\n[toc]\n## with markdown-it-toc-done-right rulezz even more");
   

问题二：如何在 Markdown 文档中插入目录？

解决步骤：

1. 在你希望目录出现的位置插入 TOC 占位符。有以下几种形式可以选择：

   • $[toc]
   • [[toc]]
   • [toc]
   • [[_toc_]]

2. 确保插件已经被正确地引入和配置。

问题三：如何自定义 TOC 的样式和功能？

解决步骤：

1. 当使用 markdown-it-toc-done-right 插件时，你可以传递一个选项对象来自定义插件的行为：

   md.use(require('markdown-it-toc-done-right'), {
       placeholder: '[[toc]]',  // 自定义 TOC 占位符
       slugify: yourCustomSlugifyFunction,  // 自定义slugification函数
       uniqueSlugStartIndex: 1,  // 从1开始为重复slug添加索引
       containerClass: 'your-custom-class'  // 自定义TOC容器的类名
   });
   

2. 根据需要修改选项对象的属性，以达到你想要的样式和功能。

以上是 markdown-it-toc-done-right 项目的常见问题及其解决步骤。希望这些信息能帮助新手更顺利地开始使用这个插件。

markdown-it-toc-done-right A table of contents (TOC) plugin for Markdown-it with focus on semantic and security. Made to work gracefully with markdown-it-anchor. 项目地址: https://gitcode.com/gh_mirrors/ma/markdown-it-toc-done-right