プラグインとインテグレーション

プラグイン

プラグインにより、Starlightの設定やUI、動作をカスタマイズできます。また、プラグインは簡単に共有や再利用ができます。Starlightチームが公式にサポートする公式プラグインと、Starlightユーザーがメンテナンスするコミュニティ製プラグインでサイトを拡張しましょう。

公式プラグイン

Algolia DocSearch デフォルトの検索プロバイダーであるPagefindを、Algolia DocSearchに置き換えます。

コミュニティ製プラグイン

starlight-links-validator Starlightページ内のリンクが壊れていないかをチェックします。

starlight-typedoc TypeDocにより、TypeScriptコードからStarlightページを生成します。

starlight-blog ドキュメントサイトにブログを追加します。

starlight-openapi OpenAPI/Swaggerの仕様からドキュメントページを作成します。

starlight-obsidian Obsidianの保管庫をStarlightサイトに公開します。

starlight-image-zoom ドキュメントの画像にズーム機能を追加します。

starlight-utils よく使うユーティリティのコレクションでStarlightを拡張します。

starlight-view-modes ドキュメントサイトにさまざまな表示モード機能を追加します。

starlight-versions Starlightのドキュメントページをバージョン管理します。

star-warp ドキュメント内の検索結果を高速に移動します。

starlight-heading-badges MarkdownやMDXの見出しにバッジを追加します。

starlight-site-graph ページのサイドバーにインタラクティブなサイトグラフを追加します。

starlight-sidebar-topics ドキュメントを、それぞれ独自のサイドバーをもつ複数のセクションに分割します。

starlight-cooler-credit 目次の下部にStarlightやAstroへのクレジットを表示します。

starlight-giscus ドキュメントサイトにGiscusコメント機能を追加します。

starlight-videos 動画ガイドやコースでドキュメントを充実させます。

starlight-kbd キーボードショートカットを簡単にドキュメント化します。

starlight-auto-sidebar 自動生成されたサイドバーグループを調整します。

starlight-llms-txt llmstxt.orgに基づいて、ドキュメントサイトにllms.txtを追加します。

starlight-toc-overview-customizer カスタマイズ可能な概要タイトルでStarlightの目次を調整します。

starlight-markdown-blocks カスタムブロックタイプでStarlightのMarkdownアサイド構文を拡張します。

starlight-fullview-mode サイドバーを折りたたみ、コンテンツを拡大してフルスクリーン表示を実現します。

starlight-scroll-to-top ドキュメントサイトにページトップへのスクロールボタンを追加します。

starlight-codeblock-fullscreen ドキュメント内のExpressive Codeブロックにフルスクリーン切り替え機能を追加します。

starlight-auto-drafts 下書きページのデフォルト動作を調整し、本番モードでは下書きページへのサイドバーリンクを自動的に削除します。

starlight-contextual-menu Starlightドキュメントにコンテキストメニューを追加します。

starlight-changelogs プロジェクトのドキュメントと一緒に変更履歴を表示します。

starlight-github-alerts GitHubアラートをStarlightのアサイドとしてレンダリングします。

starlight-page-actions ドキュメントにページアクションボタンを追加します。

starlight-docsearch-typesense 公式のAlgolia DocSearchプラグインに代わる、Typesenseを使用した検索プラグインです。

starlight-sidebar-swipe Discord Mobileのように、モバイルデバイスで左サイドバーをスワイプ可能にします。

starlight-plugin-icons Astro Starlightのサイドバー、コードブロック、ファイルツリーにアイコンを追加します。

starlight-ui-tweaks カスタムナビゲーションリンク、広告、マーケティングフッター、よりシンプルなテーマ切り替えでコアUIコンポーネントを拡張します。

starlight-tags コンテンツの整理や検索のために、Starlightドキュメントページにタグを追加します。

コミュニティ製ツールとインテグレーション

以下のコミュニティ製ツールやインテグレーションにより、Starlightサイトに機能を追加できます。

FeelBack ユーザーフィードバックシステムをドキュメントページに追加します。

notion-to-astro NotionのエクスポートをAstro Starlightドキュメントに変換します。

astro-live-code MDXコードブロックをインタラクティブなコンポーネントとしてレンダリングします。

starlight-i18n Starlightページの翻訳を支援するVisual Studio Code拡張機能です。

starlight-package-managers 複数のパッケージマネージャーに対応したnpm関連コマンドをすばやく表示します。

starlight-showcases ショーケースページを作成するためのStarlightコンポーネントセットです。

@hideoo/starlight-plugin Starlightプラグインをすばやく雛形から作成するジェネレーターです。

starlight-to-pdf StarlightサイトをPDFファイルに変換するCLIツールです。

astro-plantuml Markdownコードブロック内のPlantUMLコンテンツをレンダリングします。

astro-mermaid Markdownコードブロック内のMermaidコンテンツをクライアントサイドでレンダリングします。

astro-d2 D2のMarkdownコードブロックをダイアグラムに変換します。

starlight-links StarlightのMarkdownおよびMDXコンテンツリンクにIntelliSenseを提供するVisual Studio Code拡張機能です。

contentisland-cli StarlightプロジェクトをContent Island Headless CMSに接続・同期して、ドキュメントを編集・管理します。

starlight-sidebar-topics-dropdown ドキュメントページを複数のサブページに分割し、サイドバーのドロップダウンメニューで切り替えられるようにします。

starlight-save-file-component Starlightサイト上にダウンロードアセットへのリンクをすばやく表示します。

starlight-contributor-list プロジェクトの全コントリビューター一覧を表示します。