GitHub Syncは、GitHubリポジトリの.mdファイルをFramer CMSコレクションに自動で取り込むプラグインです。マークダウン文書をコンテンツとして利用するチームなら、もうFramerで一つ一つコピー・ペーストする必要はありません。

主な機能

GitHubから自動でコンテンツを取り込む

指定したフォルダの.mdファイルをFramer CMSコレクションに同期させます。

• フォルダ単位での同期: リポジトリ内の特定パスを指定して、必要なコンテンツだけを選択的に連携できます。

• Frontmatterサポート: マークダウン上部のYAML情報を読み取り、CMSフィールドに自動でマッピングされます。日付、タグ、要約など、さまざまなメタデータを活用できます。

• マークダウン形式の保持: 箇条書き、見出し、リンクなどのマークダウン文法がそのまま適用され、.mdxファイルも一部サポートされます。

画像・リンクパスの自動整理

相対パスの画像やファイルも自動で見つけて適用します。

• ./image.pngのように相対パスで挿入された画像も、プラグインがリポジトリ内で自動検索して接続します。

• 絶対パス(https://...)はそのまま保持され、パスが誤っている場合は自動で削除されて壊れたリンクを防ぎます。

複雑な構造の整理

深くネストされたディレクトリ構造(例: docs/guides/getting-started.md → スラッグ: docs/guides/getting-started)もスラッグとしてスッキリ整理されます。また、ネストされた構造でコレクションを分けたい場合、各フォルダごとに個別のコレクションを作成して連携できます。

プライベートリポジトリのサポート

個人アクセストークンを使用して、非公開GitHubリポジトリも安全に連携できます。

追加情報

.mdxファイルは、マークダウンとして処理され、ReactコンポーネントやJavaScriptコードは無視されます。途中でGitHubのフォルダ構造が変更されると、ベースパスも一緒に修正する必要があり、一貫した同期を維持できますのでご注意ください。