markdown - 如何在 Mkdocs 或 Sphinx 中创建选项卡式代码块？

Question

有没有办法在 Mkdocs 或 Sphinx 中创建如下标签式代码块？

Answer 1

有sphinxcontrib-osexample，它试图实现这样的功能，但它非常初级！

他们的文档中的示例：

Answer 2

有markdown-fenced-code-tabs扩展。我将它与MkDocs.

## Tabs 

```curl
$ curl -O wget http://example.com/pk.zip
```

```wget
$ wget http://example.com/pk.zip
```

## Single block

```
$ ls -lisa
```

变成

Answer 3

对于 mkdocs，您有pymdownx.tabbed 扩展名。

您必须在mkdocs.yaml文件中声明它：

markdown_extensions:
  - pymdownx.tabbed

然后您的降价文件中的语法将是[取自文档]：

=== "Tab 1"
    Markdown **content**.

    Multiple paragraphs.

=== "Tab 2"
    More Markdown **content**.

    - list item a
    - list item b

保证可以很好地与材料主题配合使用（参见示例页面）。对于其他主题，您必须自己尝试。

Answer 4

还有https://github.com/mikecules/MarkdownBSCodeTabs for mkdocs 与 markdown-fenced-code-tabs 相同

它们都有一个问题，如果您包含多个具有相同语言的代码块，它们都将以相同的名称显示，但您将无法在它们之间切换。

此外，spark 文档（用 Jekyll 编写）有很好的代码选项卡。

例如，请参阅https://github.com/apache/spark/blob/master/docs/quick-start.md。

Answer 5

有一个 mkdocs 扩展 - CodeHilite - 它利用了另一个扩展 - SuperFences - 它为不同语言/情况下的代码示例创造了奇迹。这是PyMdown扩展集合的一部分。

此外，CodeHilite 提供：

• 超过 300 种语言的语法高亮显示（Pygments支持的一种）
• 行号
• 线路亮点