2017-02-28 2 views
0

以下のようにapdownを書くにはどのようなマークダウン構文が必要ですか? enter image description heremkdocsでの関数構文の記述方法

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. 

enter image description here

すべての答えが理解されるであろう。

+0

イメージではなくHTMLを提供できますか?ブラウザーで「ビューソース」を使用してHTMLを取得し、質問を編集してそれを組み込むことができます。 – Waylan

+0

私はhtmlコードをコピーしました。 –

答えて

0

最初の例では、dtは、構文強調を適用したコードパンです。

第2の例では、dtにはプレーンテキストのみが含まれています。あなたにも、コードのスパンを使用して近づくことができます:最初の行は、そのコードのスパンになりそのバッククォート(`)に包まれていることを

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

お知らせ。もちろん、正確な一致を得るには構文の強調表示が必要ですが、MkDocsは現在、コードスパンの構文強調表示をサポートしておらず、コードブロックのみをサポートしています。おそらくvirtualenvドキュメントはMkDocsではなくSphinxを使って構築されていたと思われます。 MkDocsは外見上のSphinxに似ていますが、それはフィーチャのフィーチャと一致しませんが、これは違いの1つです。つまり、カスタムテーマやカスタムのMarkdown Extensionsを使用することができます。

+0

これを指摘してくれてありがとう、私はスフィンクスで '.. py:function ::'を見つけましたが、MkDocsではうまくいきません。次回はスフィンクスを試してみるべきかもしれません。 –

+0

MkDocsがMarkdownを使用している間、Spinxは再構成されたテキストを使用します。それらは異なる働きをする2つの異なるマークアップ言語であり、必ずしも同じ機能を共有しているとは限りません。 – Waylan

関連する問題