マークダウン ファイルの HTML

マークダウンは記述形式です。HTML は公開フォーマットの一つです。したがって、Markdown 構文は HTML の完全な汎用性を提供するものではなく、記述されたテキストの最も一般的な要素を提供するものです。より複雑な処理を行う必要がある場合は、DevSite でサポートされている任意のインライン HTML タグとブロックレベルのタグを Markdown ファイルで使用できます。Markdown から HTML に切り替えることを示す必要はありません。以下の例のように HTML タグを使用してください。

This sentence is in Markdown with a <b>bold inline HTML tag</b>.

インライン HTML

インライン HTML タグは、Markdown 段落、リストアイテム、ヘッダー内で使用できます。また、Markdown 構文（**strong**、*emphasis* など）これは、以下の例のようにコードの一部に注意を引く場合に役立ちます。

This is a Markdown paragraph about Java:
<code>System.out.format("The square of *%d* is *%f*.*%n*", i, r);</code>

ブロックレベルの HTML

DevSite でサポートされているブロックレベルの HTML タグは、空白行で周囲のコンテンツと区切る必要があります。また、インライン HTML タグとは異なり、Markdown 構文（**strong**、*emphasis* など）は、以下の例のようにレンダリングされません。

This is a Markdown paragraph that explains Java format strings:
                                  // required blank line
<pre>
  System.out.format("The square of *%d* is *%f*.*%n*", i, r);
</pre>
                                  // required blank line
This is another Markdown paragraph.

ベスト プラクティス

DevSite でのレンダリング エラーを防ぐために、Markdown ファイルでは HTML を次の方法でフォーマットすることをおすすめします。

サポートされていないブロックレベルの HTML タグを使用しない DevSite は多くのブロックレベルの HTML タグをサポートしています。サポートされていないものを含めると HTML がテキストとしてレンダリングされるか、コードが破損します。

インデント時にタブやスペースを追加しない ブロックレベルの開始タグと終了タグは、タブやスペースでインデントしないでください。エディタによっては、タブやスペースが自動的に追加されます。ご注意ください。

This is a regular paragraph in Markdown.

<p>
    This is an HTML paragraph with proper indentation!
</p>

This is a regular paragraph in Markdown.

インデントされていないコードは相対値であることを忘れないでください。

たとえば、Markdown でリストを作成する場合、ブロックレベルの開始タグと終了タグをインデントする必要はありません。

* This is a list item in Markdown

<p>This is an HTML paragraph with proper indentation!</p>

* This is a list item in Markdown

開始タグと終了タグの間に空白行を追加しない

マークダウンと HTML を切り替える場合は、この操作は簡単ですが、単純な空白行が原因で、ページが正しくレンダリングされないことがあります。

This is a regular paragraph in Markdown.

<section>
  <p>
    hello
   </p>
  <p>
    hello
  </p>
</section>

This is a regular paragraph in Markdown.