给Github-Page加上代码展示

Ghostzhang 发表于

博客中常常会需要用到代码展示,在《用Github搭建个人博客》中也介绍了几个可以用于代码展示的站点,不过由于是跨站的服务,可能会由于种种原因访问慢甚至打不开,于是就想找找有没本地实现的方法。自己写一个?No。

在Github上找到Editr这个项目,正好能满足需求,也成功应用到了这里,当然需要一点点技巧。下面就跟大家分享下。

动手前先看看说明,看到安装的部分,下载项目文件,将editr目录放到需要的目录下,这里我放在根目录下(不是所有的文件都是必须的):

. username.github.com
|---. editr
|    |--- editr.js
|    |--- editr.css
|    |---. items #默认项目目录
|        |--- index.html
|    |---. libs
|        |--- ext.emmet.js
|        |--- parser.coffeescript.js #coffee扩展,不用可以不加载
|        |--- parser.less.js #less扩展,不用可以不加载

要引用的文件还蛮多的,有没办法不要每个页面都加载呢?想到了文件头部的设置,我们可以加一个自定义的属性,像“demo”,做为一个开关,当需要使用的时候将它设置为“true”:


---
demo: true
---

在页面头部加上样式:


{% if page.demo %}
<link rel="stylesheet" href="{{ site.url }}/editr/editr.css">
{% endif %}

在页面底部加上脚本:


{% if page.demo %}
<script src="{{ site.url }}/editr/libs/jquery.min.js"></script>
<script src="//cdn.jsdelivr.net/ace/1.1.01/min/ace.js"></script>
<script src="//cdn.jsdelivr.net/ace/1.1.01/min/ext-emmet.js"></script>
<script src="{{ site.url }}/editr/libs/ext.emmet.js"></script>
{% if page.coffee %}
<script src="{{ site.url }}/editr/libs/parser.coffeescript.js"></script>
{% endif %}
{% if page.less %}
<script src="{{ site.url }}/editr/libs/parser.less.js"></script>
{% endif %}
<script src="{{ site.url }}/editr/editr.js"></script>
<script>
    $('.editr').each(function() {
        new Editr({
            el: this,
            theme: 'clouds'
        });
    });
</script>
{% endif %}

创建一个通用的模块:


{% if page.demo %}
<div class="editr" {% if include.html %}data-files-html="{{ include.html }}"{% endif %} {% if include.css %}data-files-css="{{ include.css }}"{% endif %} {% if include.js %}data-files-js="{{ include.js }}"{% endif %}
{% if include.view %}
    {% case include.view %}
    {% when "h" %}
     data-view="horizontal"
    {% when "v" %}
     data-view="vertical"
    {% when "c" %}
     data-view="cartesian"
    {% else %}
    {% endcase %}
    {% if include.hide %}
     data-hide="{{ include.hide }}"
    {% else %}
     data-hide="all"
    {% endif %}
{% else %}
    {% if include.hide %}
     data-hide="{{ include.hide }}"
    {% elsif include.js == null %}
     data-hide="js"
    {% endif %}
{% endif %}
><span class="none">效果展示</span></div>
{% endif %}

为了方便文件的管理,我们新建一个名为“demo”的目录,并且以文章标题为目录区分不同的示例:

. username.github.com
|---. editr
|---. demo
|        |--- index.html #公共索引文件
|        |---.  关于nth-child的疑惑 #文章标题
|            |--- index.html #空文件,没有的话会报404
|            |--- 1.html
|            |--- 1.css

index.html文件内容如下:

<!DOCTYPE html>
<html lang="en">
<head>
    <title></title>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
</head>
<body></body>
</html>

把Editr的设置修改为:


<script>
    $('.editr').each(function() {
        new Editr({
            el: this,
            theme: 'clouds',
            path: '{{ site.url }}/demo/{{ page.title }}'
        });
    });
</script>

然后在对应文章中,如《关于nth-child的疑惑》这篇文章,需要展示代码的位置加入如下的代码:


<div class="editr" data-files-html="1.html" data-files-css="1.css"></div>

评论列表