3

我在我的 git 站点中遇到了一些不寻常的错误。

注意：我正在使用 Kramdown + highlight.js 来突出显示代码。

下面是我正在学习的一课。在本课中，我需要 EML在代码块中呈现（类似于 XML）。我正在使用 kramdown。我还想在代码块中呈现 HTML - 例如，我需要一个代码块来解释如何添加包含文件：

{% include _toc.html %}

恰当的例子 - 下面的课程：http: //neoninc.github.io/NEON-DataSkills-Lesson-Development/R/EML/

git url https://github.com/NEONInc/NEON-DataSkills-Lesson-Development/blob/gh-pages/_posts/EML/2015-12-12-Intro-to-EML.md

奇怪的是，当 JEKYLL 构建页面时，它正在运行包含 XML 和 HTML 的代码块。

我努力了：

<code>
<creator>
      <individualName>
        <givenName>Emery</givenName>
        <surName>Boose</surName>
      </individualName>
</creator>
</code>

这会在页面上呈现结束</code>标签，这很奇怪。如果我不使用代码标签，那么 jekyll 会尝试解析 XML。

<pre><code class="xml">
<creator>
          <individualName>
            <givenName>Emery</givenName>
            <surName>Boose</surName>
          </individualName>
</creator>
</code></pre>

这仍然尝试解析和作为 HTML 标记。

我试图切换到红地毯。但是，redcarpet 打破了我的分线框，我将其编码如下：{: .notice }用于将样式应用于 div。

<i class="fa fa-star"></i> **Data Tip:**  To figure out the full slot string, 
in `RStudio` we can use Tab Complete as we type.

最后——我的工作流程是从 RMD 到 md，所以在我构建时向每个代码块（pre 和 code）添加自定义代码是有问题的。

简而言之 - 我很难找到一个解决方案

  1. 允许带有 HTML / XML 的代码块
  2. 允许我将类/ id 应用到我的突破 div。{： 。注意 }

非常感谢您对此问题的任何反馈/指导。利亚

4

3 回答 3

12

如果您想在代码块中表示 XML/HTML，有几种方法可以做到。

第一个也是最基本的（简单且适用于每个实现）是简单地将代码块缩进至少四个空格：

    <creator>
        <individualName>
            <givenName>Emery</givenName>
            <surName>Boose</surName>
        </individualName>
    </creator>

请注意，没有使用<pre>或<code>标记。在大多数任何实现中，这将呈现为：

<pre><code>&lt;creator&gt;
    &lt;individualName&gt;
        &lt;givenName&gt;Emery&lt;/givenName&gt;
        &lt;surName&gt;Boose&lt;/surName&gt;
    &lt;/individualName&gt;
&lt;/creator&gt;
</code></pre>

请注意，XML 被转义（尖括号被 HTML 实体替换），因此浏览器不会将其解释为 HTML。然而，它会为读者正确显示它。

由于 Highligh.js 具有自动语言检测功能，这对于大多数代码块来说应该足够了。如果您担心 Highlight.js 会被转义的 XML 混淆，请不要担心，Highlight.js 实际上希望得到这样的转义代码。如果给定未转义的 XML，则更有可能感到困惑。但是，如果您想明确定义语言，那么您仍然有几个选择。

要使用原始 HTML 创建您自己的代码块（可能为语法高亮分配一个类），您需要自己手动转义 XML。将以下文本直接插入到您的 Markdown 文档中：

<pre><code class="xml">&lt;creator&gt;
    &lt;individualName&gt;
        &lt;givenName&gt;Emery&lt;/givenName&gt;
        &lt;surName&gt;Boose&lt;/surName&gt;
    &lt;/individualName&gt;
&lt;/creator&gt;
</code></pre>

请注意，在这种情况下，代码块没有缩进，因为它是原始 HTML，应该按原样解释。当然，每次都像这样手动转义 XML 不是很方便。

作为替代方案，一些 Markdown 实现包含一个称为“隔离代码块”的附加组件，它不需要缩进，但允许将类分配给代码块并提供自动转义。事实证明，Kramdown支持此功能。要使用它，请执行以下操作：

~~~ xml
<creator>
    <individualName>
        <givenName>Emery</givenName>
        <surName>Boose</surName>
    </individualName>
</creator>
~~~

Kramdown 会输出这个：

<pre><code class="language-xml">&lt;creator&gt;
    &lt;individualName&gt;
        &lt;givenName&gt;Emery&lt;/givenName&gt;
        &lt;surName&gt;Boose&lt;/surName&gt;
    &lt;/individualName&gt;
&lt;/creator&gt;
</code></pre>

请注意，XML 已正确转义，并分配了一个类来标识该语言。虽然 Kramdown 附加language-到类名后面，但 Highlight.js 可以很好地理解这一点（事实上，这是HTML5 规范推荐的格式）。正如其文档所述：

类也可以以language-或为前缀lang-。

作为旁注，起初我认为 Krandown 不支持“隔离代码块”，但那是因为我尝试了GitHub 推广的三个反引号语法（```而不是）。~~~但是，Kramdown 仅支持最早在 Markdown 邮件列表中讨论并由 Python Markdown 和 PHP Markdown Extra 多年前同时引入的较旧的原始波浪号语法。据我所知，Kramdown 是唯一仍然只使用旧代字号语法的实现（例如，Python 和 PHP 实现的现代版本都支持代字号和反引号）。

于 2016-01-07T21:33:45.180 回答
4

只需添加代码块关键字（xml,cpp等）就可以做到这一点：

```xml
<creator>
      <individualName>
        <givenName>Emery</givenName>
        <surName>Boose</surName>
      </individualName>
</creator>
```
于 2018-10-30T02:47:13.233 回答
0

您可以使用jekyll 高亮标签：

{% highlight xml %}
<creator>
      <individualName>
        <givenName>Emery</givenName>
        <surName>Boose</surName>
      </individualName>
</creator>
{% endhighlight %}

pygments highlight 的可用词法分析器在这里。

于 2016-01-06T18:11:03.787 回答