Markage使用哪种方法来管理自述文件?

时间:2017-01-12 22:06:59

标签: haskell markdown github-flavored-markdown hackage

Hackage已经能够显示Markdown自述文件for a while

但是正如人们可以在the Hackage page for hpack上看到的那样,Hackage似乎不支持与GitHub相同的表语法。

降价:

#### <a name="flags"></a>Flags

| Hpack | Cabal | Default | Notes |
| --- | --- | --- | --- |
| `description` | `description` | | Optional |
| `manual` | `manual` | | Required (unlike Cabal) |
| `default` | `default` | | Required (unlike Cabal) |

在GitHub上呈现:

enter image description here

在Hackage上呈现:

enter image description here

所以,我想知道:

  • Hackage支持哪种Markdown方言?
  • 该方言中的表格是否有语法?
  • GitHub和Hackage都支持Markdown子集中的表格语法吗?

1 个答案:

答案 0 :(得分:5)

快速search through the source Hackage显示使用cheapskate(由Pandoc的作者John MacFarlane提供)。查看Cheapskate.Types,您可以看到所支持的所有内容 - 表格不是其中的一部分。

此外,它似乎是Hackage has the raw HTML option for rendering set to False,从而消除了人们对放入一个简单的HTML表格的希望(我认为它也适用于GitHub)。

我认为最好的选择(由Hackage和GitHub支持)只是将您的表放在代码块中。这样,它至少是等宽字体(因此列可以对齐)。这意味着你输入类似

的东西
```
| Header1 | Header2 | Header2 |
+---------+---------+---------+
| Cell1   | Cell2   | Cell3   |
+---------+---------+---------+
```

它将呈现为

| Header1 | Header2 | Header2 |
+---------+---------+---------+
| Cell1   | Cell2   | Cell3   |
+---------+---------+---------+