入門
Starlightは、Astroの上に構築された、フル機能のドキュメント向けテーマです。このガイドは、あなたが新しいプロジェクトを始める手助けをします。既存のAstroプロジェクトにStarlightを追加するには、手動セットアップの手順を参照してください。
クイックスタート
新しいプロジェクトの作成
ターミナルで以下のコマンドを実行し、Astro + Starlightの新しいプロジェクトを作成します。
npm create astro@latest -- --template starlightpnpm create astro --template starlightyarn create astro --template starlightこれにより、サイトに必要なすべてのファイルと設定が含まれた、新しいプロジェクトディレクトリが作成されます。
開発用サーバーの起動
ローカルで作業する場合、Astroの開発サーバーにより作業内容のプレビューができ、また変更を加えるとブラウザが自動的に更新されます。
プロジェクトのディレクトリ内で以下のコマンドを実行して、開発サーバーを起動します。
npm run devpnpm devyarn devターミナルにローカルプレビューのURLが表示されます。このURLを開くと、サイトを閲覧できます。
コンテンツの追加
Starlightに新しいコンテンツを追加したり、既存のファイルを追加したりする準備ができました！
src/content/docs/ディレクトリにMarkdownファイルを作成することで、サイトに新しいページを追加できます。
ファイルベースのルーティングや、MDXとMarkdocファイルのサポートについて、詳しくは「ページ」ガイドを参照してください。
次のステップ
- 設定: 「Starlightのカスタマイズ」で、よく使われるオプションについて学びましょう。
- ナビゲーション: 「サイドバーのナビゲーション」ガイドで、サイドバーを設定しましょう。
- コンポーネント: 「コンポーネント」ガイドで、カードやタブなどの組み込みコンポーネントを確認しましょう。
- デプロイ: Astroドキュメントの「サイトのデプロイ」ガイドを参考に、あなたの作品を公開しましょう。
Starlightを更新する
StarlightはAstroインテグレーションです。ターミナルで以下のコマンドを実行すると、他のAstroパッケージと一緒にStarlightを更新できます。
npx @astrojs/upgradepnpm dlx @astrojs/upgradeyarn dlx @astrojs/upgradeStarlightのチェンジログから、各リリースでおこなわれた変更の全リストを確認できます。
Starlightのトラブルシューティング
プロジェクト設定と個別ページのフロントマターの設定のリファレンスページを確認して、Starlightサイトが正しく設定され、正常に動作していることを確認してください。コンテンツの追加やStarlightサイトのカスタマイズについては、サイドバーにあるガイドを参照してください。
これらのドキュメントで答えが見つからない場合は、Astroに関してより詳細に記述されているAstroドキュメントを参照してください。Starlightテーマの下でAstroがどのように動作しているかを理解することで、疑問が解消されるかもしれません。
また、GithHub上でStarlightのIssueを確認したり、AstroのDiscordで活発でフレンドリーなコミュニティに助けを求めることもできます！#supportフォーラムに「starlight」タグを付けて質問を投稿したり、#starlight専用のチャンネルにアクセスして、現在の開発などについて議論しましょう！