Question

我正在尝试为开源项目贡献一些文档，所以我试图在本地预览文档页面，这是github网站的一部分。但是，我的代码块没有正确格式化。我创建了一个最小的例子：

_config.yml

markdown: kramdown
highlighter: rouge
kramdown:
  input: GFM
  hard_wrap: false
  parse_block_html: true
name: test

default.html中

<!doctype html>
<html>
<body>{{ content }}</body>
</html>

auth.md

---
layout: default
---
## Authentication

Some description.

```scala
case class User(id: Long, name: String)
// defined class User
```

jekyll build产生的结果是

<!doctype html>
<html>
<body><h2 id="authentication">Authentication</h2>

<p>Some description.</p>

<div class="language-scala highlighter-rouge"><span class="k">case</span> <span class="k">class</span> <span class="nc">User</span><span class="o">(</span><span class="n">id</span><span class="k">:</span> <span class="kt">Long</span><span class="o">,</span> <span class="n">name</span><span class="k">:</span> <span class="kt">String</span><span class="o">)</span>
<span class="c1">// defined class User
</span></div>
</body>
</html>

这导致一长串未格式化的代码。在github网站上（您可以在此处看到http://http4s.org/docs/0.15/auth.html），html包含<pre>和<code>个元素。像这样：

<div class="language-scala highlighter-rouge"><pre class="highlight"><code><span class="k">...

由于其他人没有在本地预览网站时遇到此问题，并且我在预览http://typelevel.org/cats/时遇到同样的问题，我认为这是某种本地配置问题。但是，我无法弄清楚任何事情。这是我第一次使用jekyll / kramdown，所以我没有经验可以利用。

我安装了github-pages gem，它给了我jekyll 3.3.1和kramdown 1.11.1。

Answer 1

如果它可以帮助其他人：

在通过Github文档挖掘之后我发现了它。它实际上是一个版本并安装了宝石问题。存储库中有一个Gemfile和Gemfile.lock文件。首先，它们没有被构建过程复制到运行站点的目录。而且，我需要安装bundler gem以使用bundle install安装依赖项。然后使用bundle exec jekyll serve运行该网站。这与回购网站上的说明不同。

Jekyll / kramdown没有正确格式化scala

1 个答案: