GitHub Sync is a plugin that automatically imports .md files from a GitHub repository into a Framer CMS collection. For teams utilizing markdown documents as content, there's no need for manual copy-pasting in Framer anymore.

Main Features

Automatic Content Import from GitHub

It synchronizes .md files from a specified folder into a Framer CMS collection.

• Folder-based Sync: By specifying a particular path in the repository, you can selectively integrate only the necessary content.

• Frontmatter Support: YAML information at the top of markdown is automatically mapped to CMS fields. You can utilize various metadata like date, tags, and summary.

• Maintain Markdown Format: Markdown syntax such as bullet points, headings, and links are applied as is, with partial support for .mdx files.

Automatic Cleanup of Image and Link Paths

Files and images with relative paths are automatically located and applied.

• Images inserted with a relative path like ./image.png are automatically searched and connected by the plugin within the repository.

• Absolute paths (https://...) are preserved, and incorrect paths are automatically removed to prevent broken links.

Simplification of Complex Structures

Deeply nested directory structures (for example, docs/guides/getting-started.md → slug: docs/guides/getting-started) are neatly organized into slugs. Moreover, if you want to divide collections by nested structures, you can create and integrate individual collections for each folder.

Support for Private Repositories

Private GitHub repositories can also be securely integrated via personal access tokens.

Additional Information

.mdx files are processed as markdown, while React components or JavaScript code are ignored. If there's a change in the GitHub folder structure, remember to update the base path to maintain consistent synchronization.