マークダウン・タグ付けを使用して、Jupyter ノートブックのプロジェクトの README セルまたはマークダウン・セルの読みやすさを向上させることができます。 README ファイルのマークダウンとノートブックのマークダウンの違いについて説明します。
見出し:ノートブック・タイトルおよびセクション見出しの場合は、#s の後にブランク・スペースを使用します。
#
タイトル##
メジャー見出し###
副見出し####
4th レベルの副見出し
強調: 使用するコード: 太字: __string__
または**string**
、イタリック: _string_
または*string*
、取り消し線: ~~string~~
数学記号: 使用するコード: $ mathematical symbols $
モノスペース・フォント: テキストを逆単一引用符 (`) で囲みます。 ファイル・パスとファイル名にはモノスペースを使用し、ユーザーが入力するテキストまたはユーザーに表示されるメッセージ・テキストにはモノスペースを使用します。
改行: マークダウンでは、必要に応じて改行しないことがあります。 行の末尾に 2 つのスペースを置くか、次のコードを使用して手動で改行します:<br>
字下げ引用符: 大なり記号 (>
) を使用し、次にスペースを使用して、テキストを入力します。 テキストはインデントされ、次のキャリッジ・リターンまで左側にグレーの横線が付きます。
黒丸: ダッシュ記号 (-
) の後にスペースを付けるか、スペース、ダッシュ、およびスペース (-
) を使用して、円形の黒丸を作成します。 副黒丸を作成するには、タブとその後に続くダッシュおよびスペースを使用します。 ダッシュの代わりにアスタリスクを使用しても、同様に機能します。
番号付きリスト: 先頭に1.
、スペース、テキストの順に入力します。 リターンを押すと、自動的に番号が付けられます。 各行の先頭に数字とピリオド、その後にスペースが続きます。 タブを押すとインデントされ、副番号が付けられます。
README ファイル内のチェック・ボックス: チェック・マークが付いていないボックスには、以下のコードを使用します。 - [ ]
チェック・マークが付いているボックスには、このコードを使用します。 - [x]
README ファイル内の表: 次のコードを使用します。
| Heading | Heading |
| ----| ----|
| text | text |
| text | text |
ノートブックでのグラフィックス: イメージをマークダウン・セルにドラッグ・アンド・ドロップして、ノートブックに添付します。 他のセル・タイプにイメージを追加するには、Web 上でホストされているグラフィックスをこのコードで使用し、 URL/name をイメージの完全な URL と名前<img src="url/filename.gif" alt="Alt text" title="Title text" />
に置き換えます。
README ファイル内のグラフィックス: 以下のコードを使用します。![Alt text](url/filename.gif "Title text")
幾何学図形: このコードは、以下に示す 10 進数または 16 進数の参照番号で使用します。 UTF-8 幾何学図形 &#reference_number;
水平線: 以下の 3 つのアスタリスクを使用します。***
内部リンク: セクションにリンクするには、セクション・タイトルの上にアンカーを追加してから、リンクを作成します。
このコードを使用してアンカーを作成します。 <a id="section_ID"></a>
このコードを使用してリンクを作成します。 [section title](#section-ID)
section_ID がノートブックまたは README 内で固有であることを確認してください。
あるいは、ノートブックの場合は、アンカーの作成をスキップして、以下のコードを使用することができます。 [section title](#section-title)
括弧内のテキストの場合は、スペースと特殊文字をハイフンに置き換え、すべての文字を小文字にします。
すべてのリンクをテストしてください。
外部リンク: 次のコードを使用します: [link text](http://url)
新しいウィンドウまたはタブで開くリンクを作成するには、次のコードを使用します。 <a href="http://url" target="_blank" rel="noopener noreferrer">link text</a>
すべてのリンクをテストしてください。
親トピック: プロジェクト