mdBook 0.5.4公式文書の非公式日本語訳。文書とその翻訳はMPL-2.0。固定した原典 · 編集可能な日本語文書 · 固定原資料一式。 · 編集可能な英日原稿とビルド資料.
"}, {"kind": "editorial", "html": "Libxでは全文・コード・図・原目次を静的に提供します。原著の編集・実行機能は原典を参照してください。コードの非表示行は全表示し、数式は原TeX表記を保持します。章の操作説明はmdBookが生成した元の本を対象とします。
"}, {"kind": "editorial", "html": "構文を示すコードと、その出力例の文字列（英語・識別子）は原文を保持しています。Rustロゴは変更せずCC BY 4.0の通知を保持し、Rustとの提携・推奨を示しません。原素材の通知。
"}, {"kind": "editorial", "html": "画像は静的な図として1回だけ表示します。本文の画像拡大の説明は、元のmdBook出力を対象とします。その操作は原典を参照してください。
"}] prev: {"text": "mdBook固有の機能", "link": "/v0-5-4/ja/01-guide/22-format-mdbook"} next: {"text": "継続的インテグレーション", "link": "/v0-5-4/ja/01-guide/10-continuous-integration"} ---mdBookのパーサーは、CommonMark仕様に、以下で説明する拡張を加えたものに従います。簡単なチュートリアルを読んだり、CommonMarkをリアルタイムで試したりできます。Markdown全体の解説はこの文書の対象外ですが、基本事項の概要を以下に示します。詳しく知りたい場合は、Markdown Guideを参照してください。
テキストは、ほぼ予想どおりに表示されます。
Here is a line of text.
This is a new line.
次のように表示されます。
Here is a line of text.
This is a new line.
見出しには#記号を使い、独立した行に記述します。#が多いほど、小さい見出しになります。
### A heading
Some text.
#### A smaller heading
More text.
Some text.
More text.
リストは、番号なしでも番号付きでも作れます。番号付きリストでは、番号が自動で順番に付けられます。
* milk
* eggs
* butter
1. carrots
1. celery
1. radishes
URLやローカルファイルへのリンクは簡単に作れます。
Use [mdBook](https://github.com/rust-lang/mdBook).
Read about [mdBook](mdbook.md).
And now [an mdBook link] that is not inline, unlike the above.
A bare url: <https://www.rust-lang.org>.
[an mdBook link]: https://github.com/rust-lang/mdBook
Use mdBook.
Read about mdBook.
And now an mdBook link that is not inline, unlike the above.
A bare url: https://www.rust-lang.org.
.mdで終わる相対リンクは、拡張子.htmlに変換されます。できるだけ.mdへのリンクを使うことを推奨します。GitHubやGitLabなど、Markdownを自動表示するサービスで、mdBook以外からMarkdownファイルを読むときにも便利です。
README.mdへのリンクは、index.htmlに変換されます。GitHubなどのサービスはREADMEを自動表示しますが、ウェブサーバーは通常、ルートのファイル名としてindex.htmlを期待するためです。
#フラグメントで、個々の見出しにリンクできます。たとえば、mdbook.md#text-and-paragraphsは、上にあるテキストと段落の節を指します。IDは、見出しを小文字にしたり、空白をハイフンに置き換えたりして生成されます。見出しをクリックしてブラウザーのURLを見ると、フラグメントを確認できます。
画像は、上のリンクの節と同じように、画像へのリンクで挿入します。次のMarkdownは、このファイルと同じ階層のimagesディレクトリにある、RustロゴのSVG画像を挿入します。
mdBookでビルドすると、次のHTMLを生成します。
<p><img src="images/rust-logo-blk.svg" alt="The Rust Logo" /></p>
次のように画像が表示されます。
mdBookには、標準のCommonMark仕様を超える拡張がいくつかあります。
テキストの両側を、1つまたは2つのチルダで囲むと、中央を通る横線を付けて表示できます。
An example of ~~strikethrough text~~.
この例は、次のように表示されます。
An example of
strikethrough text.
GitHubの取り消し線拡張に従います。
脚注は、本文中に小さな番号付きのリンクを生成します。クリックすると、項目の末尾にある脚注本文へ移動します。脚注ラベルはリンク参照に似ていますが、先頭にキャレットを付けます。脚注本文はリンク参照の定義のように、ラベルの後へ書きます。例を示します。
This is an example of a footnote[^note].
[^note]: This text is the contents of the footnote, which will be rendered
towards the bottom.
この例は、次のように表示されます。
This is an example of a footnote1.
脚注は、記述された順序に従って自動で番号が付きます。
パイプとハイフンで表の行と列を描くと、表を記述できます。対応する形のHTML表に変換されます。例を示します。
| Header1 | Header2 |
|---------|---------|
| abc | def |
この例は、次のような表になります。
| Header1 | Header2 |
|---|---|
| abc | def |
対応する正確な構文については、GitHubの表拡張の仕様を参照してください。
タスクリストは、完了した項目を示すチェックリストとして使えます。例を示します。
- [x] Complete task
- [ ] Incomplete task
次のように表示されます。
- Complete task
- Incomplete task
詳しくは、タスクリスト拡張の仕様を参照してください。
一部のASCII句読点の並びは、自動で装飾的なUnicode文字へ変換されます。
| ASCIIの並び | Unicode |
|---|---|
-- | – |
--- | — |
... | … |
" | “ または ”, 文脈に応じて |
' | ‘ または ’, 文脈に応じて |
これらのUnicode文字を手で入力する必要はありません。
この機能は既定で有効です。無効にするには、output.html.smart-punctuation設定を参照してください。
見出しには、独自のHTML IDとクラスを指定できます。見出しの文字列を変更しても同じIDを維持でき、複数のクラスを付けることもできます。
例：
# Example heading { #first .class1 .class2 }
内容がExample heading、IDがfirst、クラスがclass1とclass2である、レベル1の見出しになります。属性は空白で区切る必要があります。
詳しくは、見出し属性の仕様を参照してください。
定義リストは、用語集の項目などに使えます。用語を独立した行に書き、その後へ1つ以上の定義を続けます。各定義は、0〜2個の空白の後に:を置いて始める必要があります。
例：
term A
: This is a definition of term A. Text
can span multiple lines.
term B
: This is a definition of term B.
: This has more than one definition.
次のように表示されます。
用語は見出しと同様にクリックでき、ブラウザーのURLがその用語を直接指すようになります。
構文の詳細は、定義リストの仕様を参照してください。用語集の書き方については、Wikipediaの用語集ガイドラインも参考になります。
この機能は既定で有効です。無効にするには、output.html.definition-lists設定を参照してください。
注意書きは、重要な情報を強調するための、特別な説明枠や通知ブロックです。引用ブロックとして書き、最初の行に専用のタグを置きます。
> [!NOTE]
> General information or additional context.
> [!TIP]
> A helpful suggestion or best practice.
> [!IMPORTANT]
> Key information that shouldn't be missed.
> [!WARNING]
> Critical information that highlights a potential risk.
> [!CAUTION]
> Information about potential issues that require caution.
次のように表示されます。
Note
General information or additional context.
Tip
A helpful suggestion or best practice.
Important
Key information that shouldn’t be missed.
Warning
Critical information that highlights a potential risk.
Caution
Information about potential issues that require caution.
この機能は既定で有効です。無効にするには、output.html.admonitions設定を参照してください。
章の内容にあるすべての画像には、拡大機能があります。クリックすると大きくなり、再度クリックすると元に戻ります。キーボードで画像にフォーカスを移し、Spaceキーで拡大・縮小することもできます。
This text is the contents of the footnote, which will be rendered towards the bottom. ↩