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

Prosefly × Lotus

Lotus ドキュメント向けの Astro CMS。

Prosefly で Lotus の Markdown・MDX、ページ属性、docsNav を編集し、変更を確認して Git に公開。既存の Astro ビルドとサイトをそのまま使えます。

既存の Lotus と Astro の設定を利用し、対応するコレクション、ページ項目、docsNav を読み取ります。CMS 専用のスキーマは不要です。

Lotus 公式ドキュメントの概要ページ。セクションナビゲーション、サイドバー、カード、ページ内目次。
Lotus 公式ドキュメント:Overview。

ドキュメント用テンプレートから始める。

MDX ページ、セクションナビゲーション、ページ内目次を備えた Astro のドキュメント用スターター。コンテンツをリポジトリで管理し、製品に合うサイトにカスタマイズできます。

スクリーンショットは公式ドキュメントサイトです。スターターを土台に、ご自身の製品に合うサイトを作れます。

Prosefly エディターを試してみましょう。

サンプルの本文やページプロパティを編集して、変更を確認できます。登録は不要です。

getting-started.mdx
Prosefly

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

本文やコンポーネント、ページのプロパティを編集してみましょう。編集できるサンプルです。変更はこのページ内にのみ保持されます。

自分のファイルを、チームで書く。

既存の Lotus 文書設定を検出

対応する Lotus の docsLoader と docsSchema から、コンテンツディレクトリとページ属性を検出します。コレクション、ファイルのパス、スキーマを維持し、CMS 用の重複した定義を減らせます。

標準のナビゲーションを整理

検出された docsNav との関連付けを確認し、書き込み可能な既存のグループにページを追加したり、対応する手動項目を並べ替えたりできます。

テーマとエディター、それぞれの役割

Prosefly はリポジトリのコンテンツの編集と公開を支援。Lotus は既存の Astro ビルドでドキュメントを表示します。

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

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

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

# Your first guide

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

本文と一緒に、ナビゲーションも整理。

Lotus のナビゲーションとの関連付けを確認すると、書き込み可能な既存の docsNav セクションやグループ内でページを整理できます。ガイドの編集から配置の調整まで、同じ流れで進められます。

ナビゲーションの対応範囲を見る
Lotus と Dahlia で共通の Prosefly docsNav を表示するエディター。セクション、グループ、ページの項目が並ぶ。
Lotus・Dahlia 共通の Prosefly docsNav の例。Navigation パネルでセクションとページ順を確認できます。項目を移動しても文書ファイルの場所は変わりません。

本文とナビゲーションの変更を、まとめて確認。

コミットやプルリクエストを作成する前に、変更した文書と Lotus のナビゲーション設定をまとめて確認できます。サイトの表示とデプロイは、引き続き Astro のビルドが担当します。

公開ガイドを読む
Prosefly で文書と theme.config.json の docsNav の並べ替えを確認し、プルリクエストを作成する画面。
troubleshooting.mdx と theme.config.json のレビュー例。既存のグループ内でページを並べ替えています。

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

  1. 01

    Lotus のウェブサイトを接続

    GitHub を認証し、Lotus のインテグレーションとコンテンツのコレクションを含むリポジトリをスキャンします。

  2. 02

    検出された文書とナビゲーションを確認

    Lotus プロジェクトから読み取ったコレクション、フィールド、エディタープロファイル、対応する docsNav の紐付けを確認します。既存の定義を利用できるので、CMS 専用のスキーマは不要です。

  3. 03

    書いて、影響するファイルを確認

    ガイドを編集して配置先を選び、確認した本文と設定の変更を公開します。

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

標準ナビゲーションには、対応する Lotus インテグレーション、docsLoader、静的な docsNav 設定が必要です。docsNav がない場合や空の場合、自動ナビゲーションにはなりません。書き込み可能な既存のグループに対応し、新しいセクションの作成や動的な設定は対象外です。複雑な MDX や frontmatter はソースで編集できます。

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

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

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

さらに詳しく

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

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