js+jquery+递归实现文章内容导航

需求

给定一个形式如下的html:

<div id='nav'>
      <li>测试测试</li>
</div>
<div id="article">
<h1>1、一级标题测试</h1>
<p>test 水电费水电费水电费是 水胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h2>1.1、二级标题</h2>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h3>1.1.1、三级标题</h3>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h3>1.1.2、三级标题</h3>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h2>1.2、二级标题</h2>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h2>1.3、二级标题</h2>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h1>2、一级标题测试</h1>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h2>2.1、二级标题</h2>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h2>2.2、二级标题</h2>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
<h2>2.3、二级标题</h2>
<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>

<p>test 水电费水电费水电费是 水电费水电费&nbsp; 胜多负少是水电费水电费是</p>
</div>

得到文章的导航如下图:


image.png

解决方案

实现思路:

  1. 根据h标签确定一级导航,可以是h1到h9中任意一个。
  2. 将生成一级导航需要的数据(这里用对象表示,包含id,导航内容)存入数组。
  3. 用上面生成的数组采用递归的方式逐级构建导航,形成的完整的导航数据结构,如下图:


    image.png

4、由上一步得到的数据,递归渲染出导航。

代码如下:

//此处省略了引入jquery代码。。。。
<script>
        $(document).ready(function () {
           var href_arr = [];
           //从h1开始查找到h9,找到一个就作为一级导航,然后开始构建
           for(var level=1;level<10;level++){
                $("#article h"+level).each(function (i) {
                   var obj = {};
                   var h_id = (i+1)+'_help_'+level+'_'+(i+1);
                   $(this).attr('id',h_id);
                   obj.id = h_id;
                   obj.content = $(this).text();
                   href_arr.push(obj);
               });
               if(href_arr && href_arr.length>0){
                   build_level(href_arr,level);
                   //渲染导航
                   render(href_arr);
                   break;
               }
           }

           //渲染导航
           function render(href_arr){
                 var html = render_nav(href_arr);
                 $("#nav").append(html);
           }
            function render_nav(href_arr){
                var html = '<ul>';
                for(var i=0;i<href_arr.length;i++){
                   html+= "<li><a href='#"+href_arr[i].id+"'>"+href_arr[i].content;
                   if(href_arr[i].next_level && href_arr[i].next_level.length>0){
                       html += render_nav(href_arr[i].next_level,html)
                   }
                   html+="</a></li>";
                }
                html+='</ul>';

                return html;
            }

           //构建层级关系
            function build_level(arr,level){
                for(var i=0;i<arr.length;i++){

                    arr[i].next_level = [];
                    var next_level_nodes = [];

                    if(i!=arr.length-1){
                        next_level_nodes = $("#"+arr[i].id).nextUntil("#"+arr[i+1].id,'h'+(level+1));
                    }else {
                        next_level_nodes = $("#"+arr[i].id).nextAll('h'+(level+1));
                    }

                    if(next_level_nodes && next_level_nodes.length>0){
                        next_level_nodes.each(function (j) {
                            var obj = {};
                            var h_id = (i+1)+'_help_'+(level+1)+'_'+(j+1);
                            $(this).attr('id',h_id);
                            obj.id = h_id;
                            obj.content = $(this).text();
                            arr[i].next_level.push(obj);

                        });
                        if(arr[i].next_level && arr[i].next_level.length > 0){
                           build_level(arr[i].next_level,level+1)
                        }
                    }


                }
            }
            


        });
    </script>

应用场景

后端通过富文本编辑器,如ckeditor,发布新闻或文章页面,当页面内容比较多的时候,生成导航方便读者浏览。

使用富文本编辑器可以很方便的上传图、视频、文件,个人觉得比markdown更好用。

后记

其实,最开始的需求是快速构建网站说明文档,所以看了一下docsify,确实是个好东东,但是采用的markdown,传图、视频、文件好像不太方便,对于写开发者帮助文章很适用,还有gitbook听说也不错,后续深入了解一下!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,992评论 6 493
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,212评论 3 388
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,535评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,197评论 1 287
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,310评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,383评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,409评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,191评论 0 269
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,621评论 1 306
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,910评论 2 328
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,084评论 1 342
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,763评论 4 337
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,403评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,083评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,318评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,946评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,967评论 2 351