執筆の基本
Methanol は Markdown と MDX を標準でサポートしています。ドキュメントの構造は Markdown で記述し、より高度なレイアウトやインタラクティブな要素が必要な場合に JSX コンポーネントを導入するのが基本スタイルです。
ページの基本構造
---
title: マイページ
excerpt: メタタグ用の短い要約
---
# マイページ
ここにコンテンツを記述します。
ページ冒頭の --- で囲まれたブロックは「フロントマター(Frontmatter)」と呼ばれ、ページの構成やメタデータを定義します。詳細は後述します。
見出しと目次構造
##、###、#### などの見出しは、自動的に目次の生成に使用されます。適切な階層構造を維持することで、サイドバーの目次の可読性が向上します。
本文と段落
Markdown の本文は、主に「段落」で構成されます。
- 段落を分けるには、空行を挿入します。
- 段落内での改行は通常、空白として処理されます(強制的な改行にはなりません)。
- 強制的に改行させたい場合は、行末に 2 つの半角スペースを入れるか、
<br />タグを直接記述します(MDX は JSX/HTML の記述が可能です)。
例:
第1段落 1行目
第1段落 2行目(通常は前の行と結合されます)
第2段落
この行の末尾にはスペースが2つあります
そのため、ここで改行されます
引用(Blockquotes)
> これは引用ブロックです。
>
> `>` のみの行を挿入することで、引用内での空行を表現できます。
> 連続する引用行は 1 つのブロックとしてまとめられます。
> 間に空行を挟むと、別の引用ブロックとしてレンダリングされます。
レンダリング結果:
これは引用ブロックです。
>のみの行を挿入することで、引用内での空行を表現できます。 連続する引用行は 1 つのブロックとしてまとめられます。
間に空行を挟むと、別の引用ブロックとしてレンダリングされます。
コードブロック
言語識別子を指定したフェンス付きコードブロックを使用します。
```js
export const title = 'Hello'
```
レンダリング結果:
export const title = 'Hello'
Markdown の学習リソース
本ガイドでは Methanol と MDX の組み合わせに特化した内容を解説しています。Markdown 本体の詳細な記法については、以下の外部リソースも参考にしてください。
フロントマターの設定例
執筆時によく使用されるフィールドは以下の通りです。
title: ページタイトルおよびナビゲーションでの表示名excerpt: メタタグ用の短い説明文date: 公開日(ISO 形式)weight: ナビゲーション内での表示順序
詳細な一覧については、Frontmatter リファレンス を参照してください。