Repolode
投稿する
withastro

withastro/starlight

Astroを基盤に、MarkdownやMDXから高速でアクセシブルなドキュメントサイトを作成できるフレームワーク。

GitHub で見る公式サイト
スター
9,530
フォーク
1,084
未解決の Issue
39
最終コミット
昨日

これは何？

Starlightは、Astroを基盤にドキュメントサイトを構築するためのフレームワークです。レイアウトやナビゲーション、検索を一から組み立てずに、ひととおり揃ったドキュメントサイトを用意したいチームを想定しています。

Astroがサイトとしてレンダリングする、ドキュメント向けの構成をあらかじめ提供します。Starlight自体のドキュメントもStarlightで構築されており、フレームワークの実用例として参考にできます。

StarlightはコントリビューターによってMITライセンスのもとでメンテナンスされており、Astro DiscordやGitHubのissueを通じてサポートを受けられます。

主な機能

  • 01Astroフレームワークを基盤にドキュメントサイトを構築できます。
  • 02ナビゲーションを備えた、完成度の高いドキュメント用レイアウトを提供します。
  • 03Astroのツールチェーンを使って静的サイトを出力します。
  • 04Astroのコンテンツコレクション形式のコンテンツファイルでドキュメントを作成できます。

ユースケース

  • プロジェクトの製品ドキュメントやAPIドキュメントをWebサイトとして公開する。
  • チームのナレッジベースや社内ハンドブックを構築する。
  • オープンソースライブラリのドキュメントサイトを作成する。

クイックスタート

  1. 1

    セットアップ手順については Starlight のドキュメントをお読みください

使う前に知っておきたいこと

  • README にインストールコマンドが記載されていないため、セットアップの詳細は外部ドキュメントで確認する必要があります。
  • Starlight は Astro をベースに構築されているため、Astro フレームワークに慣れている必要があります。

収録されている特集

静的サイトジェネレーターとドキュメントツール

トピック

#astro#documentation#static-site-generator#docs-generator#markdown#starlight

よくある質問

starlight とは？
Astroを基盤に、MarkdownやMDXから高速でアクセシブルなドキュメントサイトを作成できるフレームワーク。 Starlightは、Astroを基盤にドキュメントサイトを構築するためのフレームワークです。レイアウトやナビゲーション、検索を一から組み立てずに、ひととおり揃ったドキュメントサイトを用意したいチームを想定しています。
starlight は無料で使えますか？ライセンスは？
starlight は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
starlight は今もメンテナンスされていますか？
活発にメンテナンス中。starlight の最終コミットは 2026年11月6日 です。
starlight は何に使えますか？
プロジェクトの製品ドキュメントやAPIドキュメントをWebサイトとして公開する。 チームのナレッジベースや社内ハンドブックを構築する。 オープンソースライブラリのドキュメントサイトを作成する。
starlight のインストール方法は？
セットアップ手順については Starlight のドキュメントをお読みください
starlight はどこで入手できますか？
ソースコードとインストール手順は GitHub にあります：https://github.com/withastro/starlight

概要はプロジェクトの README をもとに AI が生成しています。GitHub の数値は毎日更新されます。

関連プロジェクト