Repolode
sdorra

sdorra/content-collections

ローカルのMarkdown、MDX、JSON、YAMLファイルを、Webアプリ向けの型安全なデータコレクションに変換するTypeScriptツールです。

スター
1,203
フォーク
53
未解決の Issue
54
最終コミット
18 時間前

これは何?

Content Collectionsはディレクトリからファイルを読み込み、アプリから直接インポートできる型付きデータコレクションに変換します。コンテンツファイルを取得・解析するコードを書く代わりに、スキーマを指定して設定ファイルでコレクションを定義すると、ビルド時にコンテンツが解析・検証されます。

スキーマによって各エントリーが検証されるため、フィールドの誤りや不足をビルド時に検出できます。エントリーはアプリに渡す前に変換でき、たとえばMarkdownのレンダリング、コレクションの結合、サーバーからのデータ取得が可能です。開発中は、コンテンツを変更すると、サーバーの再起動やブラウザーの再読み込みなしでコレクションが更新されます。

Next.js、Remix (Vite)、SvelteKit、Solid Start、Qwik、Vite向けのアダプターを利用でき、その他のフレームワークにはCLIを使用できます。

主な機能

  • 01スキーマを含む設定ファイルで型付きコレクションを定義できます。
  • 02ビルド時にコンテンツを検証し、問題を早期に検出できます。
  • 03開発中にコンテンツが変更されると、コレクションが自動的に更新されます。
  • 04アプリに渡す前にエントリーを変換できます。
  • 05複数のフレームワーク向けアダプターと、その他のフレームワーク向けCLIを提供します。

ユースケース

  • Next.jsやSvelteKitのプロジェクトで、MarkdownまたはMDXファイルからブログやドキュメントサイトを構築する。
  • Viteアプリで構造化されたYAMLやJSONデータを型付きオブジェクトとして読み込む。
  • コンテンツディレクトリを検証し、不正なエントリーがある場合にビルドを失敗させる。

クイックスタート

  1. 1

    フレームワークアダプターを選び、READMEのリンクからインストールガイドに従います

  2. 2

    プロジェクトのルートにcontent-collections.tsファイルを作成し、コレクションを定義します

  3. 3

    コレクションのディレクトリにMarkdownコンテンツを書き、生成されたコレクションをアプリにインポートします

収録されている特集

トピック

よくある質問

content-collections とは?
ローカルのMarkdown、MDX、JSON、YAMLファイルを、Webアプリ向けの型安全なデータコレクションに変換するTypeScriptツールです。 Content Collectionsはディレクトリからファイルを読み込み、アプリから直接インポートできる型付きデータコレクションに変換します。コンテンツファイルを取得・解析するコードを書く代わりに、スキーマを指定して設定ファイルでコレクションを定義すると、ビルド時にコンテンツが解析・検証されます。
content-collections は無料で使えますか?ライセンスは?
content-collections は MIT ライセンスのオープンソースです。商用製品で使う前にライセンス条件を確認してください。
content-collections は今もメンテナンスされていますか?
活発にメンテナンス中。content-collections の最終コミットは 2026年11月6日 です。
content-collections は何に使えますか?
Next.jsやSvelteKitのプロジェクトで、MarkdownまたはMDXファイルからブログやドキュメントサイトを構築する。 Viteアプリで構造化されたYAMLやJSONデータを型付きオブジェクトとして読み込む。 コンテンツディレクトリを検証し、不正なエントリーがある場合にビルドを失敗させる。
content-collections のインストール方法は?
フレームワークアダプターを選び、READMEのリンクからインストールガイドに従います プロジェクトのルートにcontent-collections.tsファイルを作成し、コレクションを定義します コレクションのディレクトリにMarkdownコンテンツを書き、生成されたコレクションをアプリにインポートします
content-collections はどこで入手できますか?
ソースコードとインストール手順は GitHub にあります:https://github.com/sdorra/content-collections

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

関連プロジェクト