UP
Fenced Code Blocks
前のページへ
Python-Markdown Extensionsのつたない翻訳
次のページへ
Tables


Footnotes(脚注)

執筆:2018/01/01
更新:2018/01/13

【 目次 】

要約

Footnotes extensionでは、Markdown文書の脚注を定義するための構文が追加されています。
この extensionは標準のMarkdownライブラリに含まれています。

構文

Python-Markdownの脚注構文は、Markdownコミュニティの一般的に受け入れられている構文に従い、PHP Markdown Extraの脚注の実装とほぼ完全に一致します。
唯一の違いは、出力に若干の微妙な違いがあります。

例:

Footnotes[^1] have a label[^@#$%] and the footnote's content.

[^1]: This is a footnote content.
[^@#$%]: A footnote on the label: "@#$%".

脚注ラベルは、キャレット^で始まり、角括弧[]の間にインラインテキスト(スペースを含む)を入れることができます。
最初のキャレットだけが特別な意味を持ちます。

脚注の内容は、ラベルとコロンと少なくとも1つのスペースで始まる必要があります。
コンテンツを定義するために使用されるラベルは、本文で使用されるラベル(大文字と空白を含む)と正確に一致する必要があります。
コンテンツは、同じ行または次の行のいずれかのラベルに従います。
コンテンツには、複数の行、段落、コードブロック、ブロッククォート、その他ほとんどのマークダウン構文を含めることができます。
追加行は、1つのレベル(4つのスペースまたは1つのタブ)でインデントする必要があります。

複数のブロックを扱う場合、コンテンツを定義するラベルとは別の行でコンテンツを開始すると便利です。
このようにして、ブロック全体が一貫してインデントされ、どのエラーも著者によってより簡単に識別されます。

[^1]: 
    The first paragraph of the definition.

    Paragraph two of the definition.

    > A blockquote with
    > multiple lines.

        a code block

    A final paragraph.

使い方

extensionの一般的な使用法については、Extensionsを参照、extensionの名前として markdown.extensions.footnotesを指定してください。
extensionsの設定については、Library Reference — Python Markdownを参照してください。

出力を設定するには、次のオプションが用意されています。

  • PLACE_MARKER:脚注がレンダリングされる位置をマークするために使用されるテキスト文字列。
    デフォルトは///Footnotes Go Here///。
    ドキュメントにプレース・マーカ・テキストが見つからない場合は、脚注の定義は結果のHTMLドキュメントの最後に配置されます。
  • UNIQUE_IDS:複数の呼び出しの間の衝突を回避するかどうかreset()。デフォルトは False。
  • BACKLINK_TEXT:脚注の定義からドキュメント内の位置にリンクするテキスト文字列。デフォルトは↩(↩)。
ページのトップへ戻る