UP
Smart_Strong
前のページへ
Python-Markdown Extensionsのつたない翻訳
次のページへ
CodeHilite


Admonition(助言 - 説諭、 訓戒、 警告)

初回公開:2018/01/01
最終更新:2018/01/13

Admonition Extension — Python Markdown」をつたない翻訳,勝手な解釈。

【 目次 】

要約

Admonition extensionは、MarkdownドキュメントにrST-styleのアドバイスを追加します。
このextensionは標準のMarkdownライブラリに含まれています。

構文

Admonitionsは、次の構文を使用して作成されます。

!!! type "optional explicit title within double quotes"
    Any number of other indented markdown elements.

    This is the second paragraph.

typeはCSSのクラス名とデフォルトのタイトルとして使われます。
それは単一の単語でなければなりません。
したがって、たとえば:

!!! note
    You should note that the title will be automatically capitalized.

は以下のようにレンダリングされるでしょう:

<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You should note that the title will be automatically capitalized.</p>
</div>

必要に応じて、カスタムタイトルを使用できます。 例えば:

!!! danger "Don't try this at home"
    ...

は以下のようにレンダリングされるでしょう:

<div class="admonition danger">
<p class="admonition-title">Don't try this at home</p>
<p>...</p>
</div>

タイトルが必要ない場合は、空の文字列""を使用します。

!!! important ""
    This is a admonition box without a title.

結果:

<div class="admonition important">
<p>This is a admonition box without a title.</p>
</div>

rSTは次のようtypesに示唆していますが、attention(注意), caution(注意), danger(危険), error, hint(ヒント), important(重要), note(メモ), tip(ヒント), warning(警告)など、自由に使用できます。

スタイリング

この拡張の一部としてCSSは含まれていません。
どのように表示すればよいかについては、デフォルトの Sphinxテーマを参考にしてください。

訳者による追加

rSTというのは

参考までにattention, cautionとかの意味は

「Sphinxテーマ」ってSphinxを使ったことが無いのでようわからんけど。

ページのトップへ戻る