Repolode
cloudflare

cloudflare/nimbus

編集可能なレイアウトやコンテンツをリポジトリにコピーし、エージェントが読み取れる形式を標準で備えたAstroベースのドキュメントサイト雛形。

代替できる製品:Read the DocsGitBook

スター
1,430
フォーク
52
未解決の Issue
10
最終コミット
18 時間前

これは何?

Nimbusは、完全なAstro製ドキュメントサイトをリポジトリ内に構築します。レイアウト、コンポーネント、スタイル、ルート、コンテンツは実際のソースファイルとして書き出されるため、最初のコミットから編集できます。一方、基盤となる仕組みはnpmパッケージとして提供されます。

このプロジェクトは、クローズドなドキュメントフレームワークをテーマでカスタマイズするのではなく、ドキュメントのコードベースを自分たちで管理したいチームを対象としています。scaffolderコマンドでは、出力モード、デプロイ先、パッケージマネージャー、スターターコンテンツを選んでプロジェクトをセットアップできます。オプションのコンポーネントやユーティリティは、後からレジストリ経由で追加でき、編集可能なファイルとして取り込む方法と、コーディングエージェントにプロジェクトへ適用させるレシピとして取り込む方法があります。

標準では、検出可能なすべてのページを整形済みのMarkdownおよびMDXソースとして利用でき、サイトには/llms.txt、/llms-full.txt、JSON-LD、サイトマップ、ページごとのOG画像も含まれます。第一級のデプロイ先はCloudflareですが、静的出力を使えばどのホストにもデプロイできます。プロジェクトはまだ1.0未満のため、公開APIはマイナーリリース間で変更される可能性があります。

主な機能

  • 01編集可能なレイアウト、コンポーネント、スタイル、コンテンツを備えたAstro製ドキュメントサイトを構築します。
  • 02検出可能なすべてのページのMarkdownおよびMDXソースに加え、/llms.txtと/llms-full.txtを提供します。
  • 03全文検索、ライト・ダークテーマ、パンくずリスト、モバイル用サイドバーを備えています。
  • 04文章とMDXのlintに加え、わかりやすいエラーを表示する設定検証機能を提供します。
  • 05canonical linkと自動リダイレクトに対応したバージョン管理付きドキュメントをサポートします。
  • 06レジストリから必要に応じてオプションのコンポーネントや機能を追加できます。

ユースケース

  • チームがコードを完全に管理・カスタマイズできる製品ドキュメントサイトを構築する。
  • llms.txtとMarkdown出力を通じて、コーディングエージェントが直接読み取れるドキュメントを公開する。
  • 同梱のwrangler設定を使い、リクエスト時にレンダリングするドキュメントサイトをCloudflare Workersにデプロイする。
  • リダイレクトでバージョン間をつなぎながら、製品ドキュメントの複数バージョンを保守する。

トピック

よくある質問

nimbus とは?
編集可能なレイアウトやコンテンツをリポジトリにコピーし、エージェントが読み取れる形式を標準で備えたAstroベースのドキュメントサイト雛形。 Nimbusは、完全なAstro製ドキュメントサイトをリポジトリ内に構築します。レイアウト、コンポーネント、スタイル、ルート、コンテンツは実際のソースファイルとして書き出されるため、最初のコミットから編集できます。一方、基盤となる仕組みはnpmパッケージとして提供されます。
nimbus は無料で使えますか?ライセンスは?
nimbus は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
nimbus は今もメンテナンスされていますか?
活発にメンテナンス中。nimbus の最終コミットは 2026年10月18日 です。
nimbus は何に使えますか?
チームがコードを完全に管理・カスタマイズできる製品ドキュメントサイトを構築する。 llms.txtとMarkdown出力を通じて、コーディングエージェントが直接読み取れるドキュメントを公開する。 同梱のwrangler設定を使い、リクエスト時にレンダリングするドキュメントサイトをCloudflare Workersにデプロイする。 リダイレクトでバージョン間をつなぎながら、製品ドキュメントの複数バージョンを保守する。
nimbus はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/cloudflare/nimbus

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

関連プロジェクト