现在阅览文章的网页往往都带有一个目录,方便点击跳转。目录一般都是根据文档中的标题级别直接生成的。

现在我们也来模仿一个简单的,无非就是把<h1><h2>...的序列转化成树嘛

思路是这样,我们首先找到所有文章的所有标题并且标记上,然后开始从前往后遍历标题,如果如果遇到同一级的标题,那就直接添加这个标题到后面,如果遇到级别更低的标题(h2 遇到 h3),说明从h3开始都是我的子目录,我们递归进入h2的子目录,直到遇到下一个高级别的标题(递归中找到更高的h2),说明完整的子目录生成完成,可以返回了。每一个新的子目录<ul>都是原<li>的子目录。

// 函数的含义是,在第index个标题处生成目录树,该标题级别为hLevel
function genFromTitle(hLevel, index){
let ele = ''
while (index < $('.isTitle').length) {
let t = $('.isTitle').eq(index)
if (t.attr('hLevel') > hLevel) {
// 遇到更小的标题,递归生成
let nt = genFromTitle(t.attr('hLevel'), index)
ele += `<li>${nt.ele}</li>`
// 从nt.index到index-1的标题都处理完毕,更新index
index = nt.index
}
else if (t.attr('hLevel') < hLevel) break // 遇到更大的标题,向上返回
else {
// 相同等级平行关系,直接添加标题项,下一个
ele += `<li>
<a> ${ t.text() } </a>
</li>`;
index ++;
}
}
ele = `<ul>${ele}</ul>`
return {ele, index} //index 也要返回去,父函数继续往后生成
} // elEssay为文档挂载点,elContent为生成的目录挂载点
function makeEssayContent(elEssay, elContent) {
// 首先标记所有标题
for (let i = 1; i <= 6; i++) {
elEssay.find('h'+i).addClass('isTitle').attr('hLevel', i)
}
elContent.html(genFromTitle(1, 0).ele);//从第一个一级标题开始生成
}

对于下面的标题,可以生成正确结果:

数据结构复习

一、线性结构

1.栈和队列

2.链表

二、树形结构

1.二叉排序树

三、排序

<ul>
<li><a> 数据结构复习 </a></li>
<li>
<ul>
<li><a> 一、线性结构</a></li>
<li>
<ul>
<li><a> 1.栈和队列 </a></li>
<li><a> 2.链表</a></li>
</ul>
</li>
<li><a> 二、树形结构 </a></li>
<li>
<ul>
<li><a> 1.二叉排序树 </a></li>
</ul>
</li>
<li><a> 三、排序 </a></li>
</ul>
</li>
</ul>

添加跳转功能

不能跳转的目录是没有什么用的,我们知道网页可以通过锚点直接跳转到对应的id,所以只要给每个标题添加一个id,再给对应的目录项设置跳转点就可以了

else {
t.attr('id', 'tp'+index) // 恰好每个标题有唯一index 直接拿来用
ele += `<li>
<a href="#tp${index}"> ${ t.text() } </a>
</li>`;
index ++;
}

添加折叠功能

根据上面的图,每个ul外面的li的上一个元素就是这个ul的父元素,所以可以在这个父元素设置标记,点击时将ul折叠即可。

//econtent是我的外包裹元素,这里选中所有符合条件的父元素(能展开和收缩的)
$('.econtent li ul').parent().prev().before($('<span class="foldable">&gt;</span>')) //添加一个标记
$('.foldable').on("click", (this)=>{
$(this).next().next().slideToggle()
$(this).toggleClass('collapsed')
})

标记有各种方法,我直接使用了一个大于号,在点击的时候旋转一下,就有生动的效果:

.foldable{
display: inline;
float: left;
margin-left: -1rem; /* 左移一个字符,与没有子项的同级标题对齐 */
transition: all .2s;
}
.collapsed{
transform: rotate(90deg);
transform-origin: center;
}

最终效果:见左侧

为Markdown/HTML文档生成一个简易目录的更多相关文章

  1. php markdown 接口文档生成工具 SummerDoc

    2017年9月18日 19:20:22 星期一 因工作需要, 用PHP写了一个管理接口文档的小工具, 下边介绍一下: 浏览器展示的效果: 项目地址:(码云) 例子(http://doc.hearu.t ...

  2. Markdown 文档生成工具

    之前用了很多Markdown 文档生成工具,发现有几个挺好用的,现在整理出来,方便大家快速学习. loppo: 非常简单的静态站点生成器 idoc:简单的文档生成工具 gitbook:大名鼎鼎的文档协 ...

  3. 安装doxygen(一个自动文档生成工具)+Graphviz图形可视化软件

    参考文章: http://www.fmddlmyy.cn/text21.html http://www.cnblogs.com/duguguiyu/archive/2008/06/29/1231852 ...

  4. 微软开源全新的文档生成工具DocFX

    微软放弃Sandcastle有些年头了,微软最近开源了全新的文档生成工具DocFX,目前支持C#和VB,类似JSDoc或Sphinx,可以从源代码中提取注释生成文档之外,而且还有语法支持你加入其他的文 ...

  5. MarkDown/reST 文档发布流水线

    相信很多朋友都在使用Markdown或者restructuredText格式来编写一些技术文档,也会把这些文档放在github上分享给社区.GitHub提供了很好的Markdown格式解析支持,但是这 ...

  6. 【转载】Java Restful API 文档生成工具 smart-doc

    谁说生成api文档就必须要定义注解? 谁说生成接口请求和返回示例必须要在线? 用代码去探路,不断尝试更多文档交付的可能性. 如果代码有生命,为什么不换种方式和它对话! 一.背景 没有背景.就自己做自己 ...

  7. Objective-C规范注释心得——同时兼容appledoc(docset、html)与doxygen(html、pdf)的文档生成

    作者:zyl910 手工写文档是一件苦差事,幸好现在有从源码中抽取注释生成文档的专用工具.对于Objective-C来说,目前最好用的工具是appledoc和doxygen.可是这两种工具对于注释的要 ...

  8. 小胖求学系列之-文档生成利器(下)-smart-doc

    叮叮叮....一阵铃声响起,大家都陆续来到了课堂,看老师没来,小张和小胖又闲聊起来,小张问:怎么样,smart-doc好用吧.小胖笑着说:挺好用的,不过? 小张看卖关子,问到:不过什么,有什么新发现? ...

  9. 如何使用Markdown 编写文档

    Markdown 是一种轻量级标记语言,用来编写文本文档,一般后缀名为.md.该语言在 2004 由约翰·格鲁伯(John Gruber)创建. 由于Markdown 语法简单,易读易写,变得越来越通 ...

  10. 入坑 docsify,一款神奇的文档生成利器!

    layout: postcategory: javatitle: 入坑 docsify,一款神奇的文档生成利器!tagline: by 沉默王二tags: - java Guide 哥是我认识的一个非 ...

随机推荐

  1. git在idea中的冲突解决(非常重要)

    1.什么是冲突 冲突是指当你在提交或者更新代码时被合并的文件与当前文件不一致.读起来有点绕,结合下面的案例理解. 从上面对冲突的定义来看,冲突时发生在同一个文件上的. 2.生产上冲突的场景 常见冲突的 ...

  2. 判断数据是否是数组 返回true或false

    /**  * 判断数据是否是数组 返回true或false  * @param {obj,array} data //obj or array  */   export function isType ...

  3. 使用Web Component定义自己的专属网页组件

    什么是Web Component Web Component是一套Web浏览器的技术和规范,能够让开发者定制自己的HTML元素 来自MDN的描述: Web Component 是一套不同的技术,允许你 ...

  4. quartz监控日志(二)添加监听器

    上一章介绍监控job有三种方案,其实还有一个简单方案是实现quartz的TriggerListener. 上次我也试了这个方案,但是由于操作错误,导致没有监控成功,所以才选择分析源码来实现代理进行监控 ...

  5. Linux中级——“驱动” 控制硬件必须学会的底层知识

    驱动认知 1. 什么是驱动 驱动就是对底层硬件设备的操作进行封装,并向上层提供函数接口. 设备分类: linux系统将设备分为3类:字符设备.块设备.网络设备. 字符设备:指只能一个字节一个字节读写的 ...

  6. 22张图详解浏览器请求数据包如何到达web服务器(搞懂网络可以毕业了)

    浏览器的请求数据包如何到达web服务器? 很多读者对于其中的完整流程不是特别的了解,下面一口君通过这22张图,详细的讲解我们点击浏览器的网址之后,数据包是如何经过重重险阻到达web server的. ...

  7. Microsoft Ignite China, Watch Party - Why adopt Windows 11 today 升级了啥?

    Microsoft Ignite 2021 大会采用线上直播形式,围绕云技术.数据智能.未来工作方式.全民创新及数据安全等技术议题,结合全球及本地最新产品发布.科技趋势与成功案例,将带您体验独一无二的 ...

  8. Tomcat的配置文件中有哪些关键的配置项,它们分别有什么作用?

    Tomcat的配置文件主要包括server.xml和web.xml,它们位于Tomcat安装目录下的conf文件夹中.今天的内容重点介绍 server.xml 文件的配置,V 哥会结合一些业务场景来介 ...

  9. Zsh 配置

    基本配置 安裝 Zsh: # Ubuntu/Debian sudo apt install zsh # macOS brew install zsh macOS 默认使用 Zsh,可以不用重复安装. ...

  10. JVM笔记九-GC收集器日志信息学习

    在上一篇文章中,我们通过代码运行结果,查看到JVM的堆内存逻辑上分区是三部分,物理上分区是2部分,以及是新生代分区三部分,占比分布是8/1/1.而且我们还通过代码和堆JVM参数配置,制造出了OOM异常 ...