Prosefly
すべてのフレームワーク

Prosefly × Starlight

Starlight の文書を、CMS で共同編集。

Git を覚えなくても、チーム全員で Starlight の文書を編集。Markdown・MDX や対応するコンポーネントを編集し、本文とサイドバーの変更を確認して公開できます。今のサイトはそのまま使えます。

Starlight の既存のドキュメント設定を自動検出。対応する構成なら、CMS 専用のコレクションやフィールドの定義は不要です。

ウェブサイトを接続エディターを試す登録不要Starlight 向け CMS の導入ガイド

既存の Starlight サイトから、変更の確認・公開まで。

リポジトリを接続し、検出された Docs コレクションを確認。ガイドとサイドバーを編集する流れを、自分のサイトを接続する前に試せます。

  • Starlight の文書定義をそのまま使う

    既存の docsLoader、docsSchema、対応する静的なスキーマ拡張から、文書コレクションとページ属性を検出します。CMS 専用のスキーマを重ねて管理する必要はありません。

  • サイドバーにページを配置

    ナビゲーションとの関連付けを確認すると、書き込み可能な既存グループ内の手動項目と、autogenerate.directory で自動生成された同じディレクトリ内のページを並べ替えられます。

  • 本文とナビゲーションを一緒に確認

    コミットやプルリクエストの作成前に、本文、サイドバー設定、sidebar.order の変更をまとめて確認できます。

リポジトリ内のファイル例を見る
リポジトリ内のコンテンツの例Starlight
  • astro.config.mjs
  • src/content.config.ts
  • src/content/docs/guides/overview.mdx

選択中のリポジトリファイル

---
title: Project overview
description: Start here to get to know the project.
---

# Your first guide

A place for the things your team learns.
リポジトリの構成例です。実際のプロジェクトのパスと設定に合わせてください。

Starlight CMS の操作を試す。

サンプルリポジトリを接続し、Docs コレクションを確認。ガイドを編集して本文とナビゲーションの変更をまとめて確認します。

Prosefly/リポジトリ
getting-started.mdxProsefly / Starlight / Docs
Starlight

エディターを読み込み中…

下書きはこのページ内に保存

操作できるデモです。変更はこのページ内に留まり、リポジトリへの接続や公開は行いません。

操作できるサンプルです。変更はこのページ内だけに保存され、リポジトリへの接続や公開は行いません。

今の設定を読み取り、確認して編集へ。

  1. 01

    ドキュメントのリポジトリを接続

    GitHub を認証し、Starlight を使っている Astro アプリをスキャンします。

  2. 02

    文書・フィールド・ナビゲーションを確認

    自動検出された文書コレクション、ページ属性、エディタープロファイル、対応するサイドバーの紐付けを確認します。既存の Starlight 設定をそのまま利用できます。

  3. 03

    ガイドを書き、配置を確認

    ページを編集し、対応する配置先を選んで、公開前に影響するすべてのファイルを確認します。

接続前に知っておきたいこと

標準サイドバーの編集には、対応する静的な設定が必要です。動的な式を含む場合は、本文のみの公開が必要になることがあります。項目を移動しても Markdown ファイルの場所は変わりません。複雑な frontmatter はソースで編集できます。

Starlight で CMS を使うには

Starlight サイトの作り直しや移行は必要ですか？

不要です。GitHub リポジトリを接続し、既存の docs コレクションを使います。Starlight のテーマ、URL、ホスティング、ビルドは変わりません。公開したコンテンツはリポジトリのファイルとして今の流れに入ります。

Starlight のどのコンテンツをビジュアル編集できますか？

Markdown と、補足、タブ、カード、ファイルツリーなどの対応する MDX コンポーネントを編集できます。対応するページ属性や Expressive Code のメタデータも扱えます。独自コンポーネントや未対応の式はソースで編集できます。

Starlight のサイドバーはどう編集しますか？

手動で設定したサイドバーと、autogenerate.directory による自動グループの両方に対応しています。手動項目は書き込み可能な既存グループで配置を調整でき、自動生成ページは同じディレクトリ内でドラッグして並べ替えられます。自動生成ページの並べ替えは frontmatter の sidebar.order を更新し、Markdown ファイルを移動しません。公開前に影響するすべてのファイルを確認できます。

Starlight に Prosefly 専用の設定ファイルが必要ですか？

対応する静的な構成なら不要です。Starlight の docsLoader、docsSchema、対応する標準サイドバー設定を検出します。スキャン結果を確認して取り込めばよく、CMS 用に同じコレクションやフィールドを定義し直す必要はありません。

公開したコンテンツは、自分の Git リポジトリに。

公開するまで、下書きは Prosefly に保存されます。変更を確認してコミットまたはプルリクエストを作成すると、ウェブサイトの既存のビルドがデプロイを引き継ぎます。

コンテンツの所有権について

さらに詳しく

コンテンツスペースの接続、公開の仕組み、ウェブサイトを支えるツールについて。

ほかのフレームワークを見る