Wie schreibe ich eine Funktionssyntax in mkdocs

Question

Welche Syntax von Markdown muss ich die API wie unten schreiben.

der HTML-Code ist unten:
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> 

I Syntax wie folgt zu verwenden habe versucht, aber entpuppt genau wie, aber nicht das gleiche sein.

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

Jede Antwort wird geschätzt.

Answer 1

Im ersten Beispiel ist dt eine Codespanne, auf die Syntax-Highlighting angewendet wurde.

Im zweiten Beispiel enthält dt nur Nur-Text. Sie können auch näher kommen eine Code Spanne unter Verwendung:

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

Beachten Sie, dass die erste Zeile in Backticks gewickelt ist (`), das es sich um eine Code Spanne macht. Natürlich benötigen Sie noch Syntax-Highlighting, um eine exakte Übereinstimmung zu erhalten, aber MkDocs unterstützt derzeit keine Syntaxhervorhebung für Code-Bereiche, sondern nur Code-Blöcke. Vermutlich wurden die virtualenv-Dokumente mit Sphinx anstelle von MkDocs erstellt. Während MkDocs in Looks der passenden Sphinx nahe kommt, stimmt es Feature für Feature nicht überein und dies ist einer der Unterschiede. Das heißt, es ist möglich mit einem benutzerdefinierten Thema und/oder mit einigen benutzerdefinierten Markdown-Erweiterungen.