目录与返回链接 · 使用说明
为长文档页面自动生成目录 + 每个章节的「↑ 目录」返回链接 · 无需修改正文
快速开始(两步)
① 复制下方 CSS,粘贴到目标页面的 <style> 标签内;
② 复制下方 JS,粘贴到目标页面的 </BODY> 之前。
保存刷新,目录和返回链接会自动出现。
一、使用前提条件
- 章节标题用
<h2>。脚本只收集 <h2>,不收集 <h3>、<h4>。如果某些小标题不想进目录,就不要用 <h2>。
- 页面最好有一个
<h1> 主标题。目录会插在它后面;如果页面没有 <h1>,目录会插到正文容器最前面。
- 正文建议包在一个容器里(如
<span class="hanziJieshi"> 或 <div class="content">)。脚本会优先在这个容器内查找标题;找不到就用 document.body 全局查找。
- 不需要 jQuery,纯原生 JS,现代浏览器均可运行。
- 不需要修改正文 HTML。脚本自动给每个
<h2> 加 id、自动追加「↑ 目录」链接、自动生成目录。
- 文件编码建议 UTF-8。如果目标页面必须用 gb2312,也没问题——JS 里所有中文字符串已用
\uXXXX 转义,不会乱码。
二、第一步:复制 CSS
把下面的 CSS 粘贴到目标页面的 <style> 标签内,或保存为外部 .css 文件后引入。建议放在原有样式之后,避免被覆盖。
三、第二步:复制 JS
把下面的 JS 粘贴到目标页面的 </BODY> 之前。不要放在 <head> 里(虽然脚本内部已处理加载时机,但放底部更稳妥)。
四、可选:底部加一个「目录」链接
目标页面底部通常已有「返回前一页 / 返回顶部」。如果想再加一个「目录」链接,在底部 <center> 里补一行即可(#mulu 是脚本自动生成的目录容器 id,无需额外改动):
五、效果说明
- 目录自动生成在
<h1> 下方,两列排布;手机等窄屏自动变单列。
- 目录收录页面中所有
<h2> 章节,按出现顺序排列。
- 每个
<h2> 右侧自动出现小按钮「↑ 目录」,点击跳回目录。
- 点击目录中的某一项,跳到对应章节顶部。
- 章节 id 自动分配为
sec1、sec2……,无需手动改。
六、常见问题
1. 目录没有出现
- 检查目标页面里是否真的有
<h2> 标题;
- 按 F12 打开 Console,看是否有红色报错;
- 确认 JS 已经粘贴并保存,且没有被浏览器缓存(强制刷新 Ctrl+F5)。
2. 章节标题右侧没有「↑ 目录」
- 多半是 CSS 没加载或选择器被覆盖,检查
.back2toc 是否存在;
- 如果目标页原有 CSS 里对
h2 设置了 overflow: hidden,可能导致浮动元素不显示,可把 .back2toc 改为绝对定位或加 display: inline-block。
3. 中文乱码
- 确认文件编码与
<meta charset> 一致;
- JS 里所有中文字符串已用
\uXXXX 转义,即使目标页面是 gb2312 也不会乱码;乱码通常来自你手动改过 JS 里的中文。
4. 目录里出现不想收录的标题
- 把那个标题从
<h2> 改成 <h3>;
- 或者给那个
<h2> 加 id="mulu-title",脚本会跳过它。
5. 想改目录标题文字
- 修改 JS 中的
\u76ee\u5f55(=“目录”)。如果目标文件是 UTF-8,可以直接写中文;如果是 gb2312,请保持 \u 转义形式。
6. 页面里已经有 id="mulu" 的元素
- 会发生 id 冲突。把脚本里
toc.id = 'mulu' 改成别的,例如 'mulu-nav',同时把「↑ 目录」链接的 href="#mulu" 改成 href="#mulu-nav"。
安全提示:本页的「复制」按钮使用浏览器剪贴板 API,在 file:// 协议下部分浏览器可能受限。如果点按钮没反应,请手动选中文本框内容后按 Ctrl+C(Mac 按 Cmd+C)复制。