AstroのStepsコンポーネント使用時のルール
Astro(Starlight)の <Steps> コンポーネントを使用する際、以下のようなエラーに遭遇することがある。
このエラーが発生する主な原因は、<Steps> 内のリスト項目の内容(テキストやコードブロックなど)を適切にインデント(スペース3〜4個)していないことである。
順序付きリストの番号(1., 2. など)自体はインデントせず、その下の要素をインデントする必要がある。
エラーを解決するための具体的な記述方法
Section titled “エラーを解決するための具体的な記述方法”公式ドキュメントの例を参考に、正しい記述手順を解説する。
-
コンポーネントのインポート
ファイルの先頭付近で
Stepsコンポーネントをインポートする。import { Steps } from '@astrojs/starlight/components'; -
順序付きリストを
<Steps>で囲み、内容をインデントするリスト番号の下の行は、必ずスペースでインデント(通常は4つ)する。
example.mdx <Steps>1. リストの項目を記述する:← 4つのスペースを入れてインデントする。4 spaces inputs to left.2. 次の項目である。</Steps>
よくある質問 (FAQ)
Section titled “よくある質問 (FAQ)”番号自体をインデントするとどうなるか?
Section titled “番号自体をインデントするとどうなるか?”番号(1. など)自体をインデントすると、Markdownパーサーが意図した順序付きリストとして認識せず、別のエラーや表示崩れを引き起こす原因となる。番号はインデントせず行頭から記述し、その内容のみをインデントすることが重要である。
<Steps>コンポーネント内のエラーは、不適切なインデントが原因である。- 順序付きリストの番号(
1.,2.など)は行頭から記述する。 - リスト項目に続くテキストやコードブロックは、必ず3〜4個のスペースでインデントする。
環境情報
astro:^4.14.2@astrojs/starlight:^0.26.1
他の記事を探す