Hexo主题maupassant目录优化解决方案

欢迎访问我的博客:https://wiki.hushhw.cn/posts/5dd904ed.html

整个探索的过程断断续续花费了我一些时间,写下这篇文章记录下这个工作的过程,并不复杂,但是有值得以后学习的地方。

问题

  • maupassant主题的目录显示在正文中,一旦目录过长就会严重影响正文的排版。
  • 将目录固定在页面上的需求

探索之路

当初选用maupassant主题就是因为其侧栏特别简约实用,如果在打开文章浏览时将目录也放入侧栏内问题不就解决了吗?于是开始扒主题源码,了解侧栏的机制并开始着手制作目录栏。

第一回

  1. 新建toc.pug文件在_widgets文件夹下:
.widget
  if page.toc
    .widget-title
      i(class='fa fa-bars')= '  ' + __('contents')
     div(id='stoc' class='stoc-article')
       != toc(page.content, {list_number: theme.toc_number})
  1. 之后在主题配置文件_config.yml中添加侧栏toc
widgets: 
  - toc
  - about
  - search
  - category
  - tag
  - archivelist
  - recent_posts
  - links
  1. style.scss中修改基本样式
.stoc-article {

    padding: 0.7em 0.7em 0 0;
  }

#stoc {
    line-height: 1em;
    .toc {
      padding: 0;
      margin: 0.5em;
      line-height: 1.8em;
      li {
        list-style-type: none;
      }
    }
    .toc-child {
      margin-left: 1em;
      padding-left: 0;
    }
}

  1. 本地执行hexo server预览
    图源:hushhw.cn

到这里我以为完结撒花啦🎉,当我发布出去后发现并没有显示出来,之后做了判断验证确实是无法显示,这个问题困扰了我很久,为什么if page.toc这句判断失败而本地预览却可以呢?侧栏无法识别当前page吗?

问题搁置了许久,问题没有解决就很闹心,今天在研究博客整体框架时突然想到把目录的配置提前,放到文章生成前的base.pug文件内,以引入的形式引入到post.pug能不能成功呢?

第二回

  1. 新建base-post.pug页面(为了避免破坏其他页面的排版),主要代码复制于base.pug,修改的部分如下:
#layout.pure-g
   .pure-u-1.pure-u-md-3-4: .content_container
      block content
   if page.toc != true
     .pure-u-1.pure-u-md-1-4: #sidebar
       each item in theme.widgets
        != partial('_widget/' + item + '.pug', null, {cache: !config.relative_link})
   else
      .pure-u-1.pure-u-md-1-4: #posttoc
        i(class='fa fa-bars')= ' TOC '
          div(id='stoc' class='stoc-article')
            != toc(page.content, {list_number: theme.toc_number})
   .pure-u-1.pure-u-md-3-4
      != partial('_partial/footer.pug')

代码进行前面类似的判断,如果当前文章在font-matter设置了toc: true即显示目录,否则显示侧栏。

  1. style.scss中修改基本样式
#posttoc{
    position: fixed;
    margin-top: 25px;
}

.stoc-article {

    padding: 0.7em 0.7em 0 0;
  }

#stoc {
    line-height: 1em;
    .toc {
      padding: 0;
      margin: 0.5em;
      line-height: 1.8em;
      li {
        list-style-type: none;
      }
    }
    .toc-child {
      margin-left: 1em;
      padding-left: 0;
    }
}

  1. 本地预览及推送发布均成功显示,说明这个尝试是可行的,终于算是解决了这个问题:
图源:hushhw.cn

另外,是否可以把目录伪装成侧栏中的一栏呢?

把代码改成如下即可:

    #layout.pure-g
      .pure-u-1.pure-u-md-3-4: .content_container
        block content
      if page.toc != true
        .pure-u-1.pure-u-md-1-4: #sidebar
          each item in theme.widgets
            != partial('_widget/' + item + '.pug', null, {cache: !config.relative_link})
      else
        .pure-u-1.pure-u-md-1-4: #sidebar
          #posttoc
            .widget
              .widget-title
                i(class='fa fa-bars')= '  ' + __('contents')
              div(id='stoc' class='stoc-article')
                != toc(page.content, {list_number: theme.toc_number})
          each item in theme.widgets
            != partial('_widget/' + item + '.pug', null, {cache: !config.relative_link})  
      .pure-u-1.pure-u-md-3-4
        != partial('_partial/footer.pug')

把目录的样式改成侧栏,然后在目录后面遍历出侧栏其它栏目。

第三回

继续优化第二个问题固定目录栏并优化移动端隐藏目录栏。

  1. 增加移动端判断并修改类名等
#layout.pure-g
      .pure-u-1.pure-u-md-3-4: .content_container
        block content
      if page.toc != true
        .pure-u-1.pure-u-md-1-4: #sidebar
          each item in theme.widgets
            != partial('_widget/' + item + '.pug', null, {cache: !config.relative_link})
      else
        if theme.toc_on_small_screens
          .pure-u-1.pure-u-md-1-4: #sidebar-toc
            div(id="sidebar-stoc" class="stoc-article")
              strong(class="stoc-title")
                i(class='fa fa-blind')= ' Contents '
              div(id="stoc" class='toc-nav')
                != toc(page.content, {list_number: theme.toc_number})
        else 
          .pure-u-1-4.hidden_mid_and_down: #sidebar-toc
            div(id="sidebar-stoc" class="stoc-article")
              strong(class="stoc-title")
                i(class='fa fa-blind')= ' Contents '
              div(id="stoc" class='toc-nav')
                != toc(page.content, {list_number: theme.toc_number})
      .pure-u-1.pure-u-md-3-4
        != partial('_partial/footer.pug')
  1. 修改样式
#sidebar-toc {
    padding-left: 15px;
    margin-top: 40px;
    padding-bottom: 20px;
    word-wrap: break-word;
}

.stoc-article{
    position: absolute;
    padding: 1em 1em 0 1em;
    margin-left: 1em;
    border-left: rgba(88,88,88,0.1) 1px solid;
}

.stoc-title{
    font-size: 150%;
}

#sidebar-stoc {
    width: inherit;
    line-height: 1em;
    font-size: 0.9em;
    float: left;
    overflow: auto;
}

.stoc-fixed{
  position: fixed;
  top: 60px;
  margin-top: 0;
  max-height: 81%;
  overflow: hidden;
  z-index: 1;
}


.toc-nav {
    padding: 0.7em 0.7em 0 0;
}

#stoc {
    line-height: 1em;
    .toc {
      padding: 0;
      margin: 0.5em;
      line-height: 1.8em;
      li {
        list-style-type: none;
      }
    }
    .toc-child {
      margin-left: 1em;
      padding-left: 0;
    }
}
  1. 添加toc.js文件放在source/js文件夹中
var toc = document.getElementById('sidebar-stoc')

if (toc != null) {
    window.addEventListener("scroll", scrollcatelogHandler);
    var tocPosition = toc.offsetTop;
    var height_header = $("#header").height();
    function scrollcatelogHandler(e) {
         var event = e || window.event,
             target = event.target || event.srcElement;
         var scrollTop = document.documentElement.scrollTop || document.body.scrollTop;
         if (scrollTop >  tocPosition -60) {
             toc.classList.add("stoc-fixed");
         } else {
             toc.classList.remove("stoc-fixed");
         }
    }
}

就是现在正在使用的样式啦!

总结

基本实现了预期功能,前后折腾了很长时间,但是这种心想事成的感觉还是很nice的呢!

后面如果有新的bug再慢慢解决吧。

更新2019.2.17

点击无法跳转,我枯了。。。

多方查找原因终于找到了根源,居然是因为aplayer播放器toc不兼容,要是没有看到别人的文章我感觉一辈子都解决不了这个问题了。

于是把播放器配置设置开关在font-matter中,在需要使用音乐播放器的页面才设为music: true,其它用到目录的页面关闭使用。

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

推荐阅读更多精彩内容

  • 问答题47 /72 常见浏览器兼容性问题与解决方案? 参考答案 (1)浏览器兼容问题一:不同浏览器的标签默认的外补...
    _Yfling阅读 13,747评论 1 92
  • 发现 关注 消息 iOS 第三方库、插件、知名博客总结 作者大灰狼的小绵羊哥哥关注 2017.06.26 09:4...
    肇东周阅读 12,081评论 4 62
  • 李暠(公元351-417年),字玄盛,陇西成纪(天水)人,西汉名将李广十六世孙,十六国时期西凉国的创建者。 李暠家...
    愚人码头1037阅读 194评论 0 3
  • 我叫豆包,第10天打卡 今日任务目标:1阶玩法后台设计,海报做出来,可用的,话术准备好 前期担心对用户痛点把握不准...
    半盏豆包阅读 122评论 0 1
  • 全局动画LayoutAnimation:这个动画的作用于是全局的,使用起来非常简单。 其中create和delet...
    IDO0阅读 356评论 0 0