メインコンテンツへスキップ
NotCMSは、チームが編集するNotionデータベースと、開発するWebサイトをつなぎます。 執筆者はNotionで作業し、開発者はTypeScript SDKを使ってNotCMSからプロパティやMarkdown本文を取得します。

コンテンツがサイトに届くまで

  1. ダッシュボードでNotionを接続し、データベースを登録して初回同期の完了を待ちます。
  2. CLIでスキーマを生成します。データベース名、プロパティ名、型、取得済みの選択肢がコードで使えるようになります。
  3. サーバー上、またはサイトのビルド時に、同期済みコンテンツを取得します。
その後のNotionの変更は、同期の完了後に利用できます。静的サイトでは再ビルドとデプロイも必要です。 サーバーで描画するサイトでも、キャッシュの更新が必要な場合があります。 NotCMSへの同期とサイトへの公開は別の段階です。Astroガイドで具体例を確認できます。

型を使ってコンテンツを取得する

セットアップ後は、生成されたクライアントをimportします。 以下は、データベース名が blog で、published というチェックボックスがある場合の例です。
スキーマは、最後の pull で取得したコンテンツの形を表します。 エディタの補完やコンパイル時の検査を可能にしますが、実行時のすべての値を検証するものではありません。 Notionデータベースを変更したら、同期してから再度pullしてください。

公開するページを選ぶ

NotCMSは、published という名前のプロパティを特別扱いしません。 アプリで公開条件を決め、一覧と個別ページの両方に適用してください。シークレットキーはサーバー側に置きます。 予約公開、言語、個別ページの確認方法は公開条件のレシピを参照してください。

クエリを選ぶ

  • 一覧取得: プロパティを取得し、必要に応じて絞り込みや並べ替えを行います。
  • 1ページの取得: IDやslugなどのプロパティを指定してMarkdown本文を取得します。
  • エラー処理: SDKのエラータプルを確認してからデータを使います。
このドキュメントは、公開済みのNotCMS 0.5.0のAPIを対象にしています。 古いプロジェクトは移行ガイドを参照してください。 まずクイックスタートを進め、その後にNext.jsや Astroとの連携を選べます。