如何在 mkdocs 中编写函数语法

Question

我需要什么markdown语法才能写出如下的api。

html代码如下：
link

<dl class="function">
<dt id="create_bootstrap_script">
<code class="descname">create_bootstrap_script</code><span class="sig-paren">(</span><em>extra_text</em><span class="sig-paren">)</span><a class="headerlink" href="#create_bootstrap_script" title="Permalink to this definition">¶</a></dt>
<dd><p>Creates a bootstrap script from <code class="docutils literal"><span class="pre">extra_text</span></code>, which is like
this script but with extend_parser, adjust_options, and after_install hooks.</p>
</dd></dl>

<p>This returns a string that (written to disk of course) can be used
as a bootstrap script with your own customizations. The script
will be the standard virtualenv.py script, with your extra text
added (your extra text should be Python code).</p>
<p>If you include these functions, they will be called:</p>

我试过使用这样的语法，但结果是一样但不一样。

    Orange(a, b)
:   The fruit of an evergreen tree of the genus Citrus.

我们将不胜感激。

Answer 1

在第一个示例中，dt 是应用了语法突出显示的代码跨度。

在第二个示例中，dt 仅包含纯文本。您也可以通过使用代码跨度来更接近：

`Orange(a, b)`
:   The fruit of an evergreen tree of the genus Citrus.

请注意，第一行用反引号 (`) 括起来，这使其成为一个代码跨度。当然，你仍然需要语法高亮来获得精确匹配，但是 MkDocs 目前不支持代码跨度的语法高亮，只支持代码块。据推测，virtualenv 文档是使用 Sphinx 而不是 MkDocs 构建的。虽然 MkDocs 在外观上接近与 Sphinx 相匹配，但它与特性不匹配，这是差异之一。也就是说，自定义主题 and/or 使用一些自定义 Markdown 扩展是可能的。

如何在 mkdocs 中编写函数语法

how to write a function syntax in mkdocs

function

mkdocs