美文网首页Hexo(+NexT)
Hexo NexT 代码块复制功能

Hexo NexT 代码块复制功能

作者: 恬雅过客 | 来源:发表于2018-06-19 16:45 被阅读9次

为了提高博客代码块的用户体验,仅仅代码高亮还不行,最好还能一键复制代码。故此文将讲述Hexo NexT主题博客的代码块复制功能配置。

下载 clipboard.js

三方插件 clipboardjs ,相关介绍和兼容性我就不赘述了,去它主页github上看。

下载地址:

保存文件clipboard.js / clipboard.min.js ,目录如下:
.\themes\next\source\js\src

clipboardjs 使用

也是在.\themes\next\source\js\src目录下,创建clipboard-use.js,文件内容如下:

/*页面载入完成后,创建复制按钮*/
!function (e, t, a) { 
  /* code */
  var initCopyCode = function(){
    var copyHtml = '';
    copyHtml += '<button class="btn-copy" data-clipboard-snippet="">';
    copyHtml += '  <i class="fa fa-globe"></i><span>copy</span>';
    copyHtml += '</button>';
    $(".highlight .code pre").before(copyHtml);
    new ClipboardJS('.btn-copy', {
        target: function(trigger) {
            return trigger.nextElementSibling;
        }
    });
  }
  initCopyCode();
}(window, document);

.\themes\next\source\css\_custom\custom.styl样式文件中添加下面代码:

//代码块复制按钮
.highlight{
  //方便copy代码按钮(btn-copy)的定位
  position: relative;
}
.btn-copy {
    display: inline-block;
    cursor: pointer;
    background-color: #eee;
    background-image: linear-gradient(#fcfcfc,#eee);
    border: 1px solid #d5d5d5;
    border-radius: 3px;
    -webkit-user-select: none;
    -moz-user-select: none;
    -ms-user-select: none;
    user-select: none;
    -webkit-appearance: none;
    font-size: 13px;
    font-weight: 700;
    line-height: 20px;
    color: #333;
    -webkit-transition: opacity .3s ease-in-out;
    -o-transition: opacity .3s ease-in-out;
    transition: opacity .3s ease-in-out;
    padding: 2px 6px;
    position: absolute;
    right: 5px;
    top: 5px;
    opacity: 0;
}
.btn-copy span {
    margin-left: 5px;
}
.highlight:hover .btn-copy{
  opacity: 1;
}

引用

.\themes\next\layout\_layout.swig文件中,添加引用(注:在 swig 末尾或 body 结束标签(</body>)之前添加):

  <!-- 代码块复制功能 -->
  <script type="text/javascript" src="/js/src/clipboard.min.js"></script>  
  <script type="text/javascript" src="/js/src/clipboard-use.js"></script>

想看效果的可以去我博客看,截图如下:

copycode-btn.png

补充

懂代码的也可以将clipboard.min.jsclipboard-use.js合并为一个文件,再在.\themes\next\layout\_layout.swig文件中使用。当然clipboard.min.js也可以直接用三方cdn的方式引入也行。

相关文章

网友评论

  • E1sewhere:博主啊,我按照你的步骤操作了,似乎不起作用.
    我查看了页面的代码元素

    <figure class="highlight plain">==$0
    <table>
    <tbody>
    <tr>
    <td class="gutter">
    <pre>
    <span class="line">1</span>
    <br>
    </pre>

    是这样的结构,按照js的规则是否能够应用呢.
    恬雅过客:给我一下你的博客地址,我需要看看你的网页解析后的代码,看看代码块部分包含在那个html标签元素上,才能调整对应的js。你发出来的只包含了行号的源码(<td class="gutter">),没看到包含代码块的源码
  • 8b04c4dc7675:请问这个复制功能在md文档编写中是自动添加到代码行中的吗?
    比如:``` hello world ```
    我这边好像实现不了这个功能,还是需要添加语句包裹呢?
    恬雅过客:@叶渝泽 这样吧,把你博客地址发出来,我看看
    8b04c4dc7675:@恬雅过客 有这些样式,也看到script引用,就是没有这个按钮
    恬雅过客:md多行代码的写法,你看看你md代码生成的页面里面有没有这些这些样式类.highlight .code pre,因为插件js就是根据“$(".highlight .code pre").before(copyHtml);”添加那个复制按钮的。
  • Remenber_Ray:棒,刚想添加这个功能,就找到这篇教程,谢谢
    恬雅过客:@Remenber_Ray 客气了。与人方便自己方便

本文标题:Hexo NexT 代码块复制功能

本文链接:https://www.haomeiwen.com/subject/ocaaeftx.html