Markdown "sync" 框架

这是一个为 AI Agent 和开发者打造的开源发布框架，用于快速上线网站、文档或博客。通过编写 Markdown 并从终端执行同步，你的内容即可立即被浏览器、LLM 和 AI Agent 获取。基于 Convex 构建。

在本地编写 Markdown，运行 npm run sync (开发环境) 或 npm run sync:prod (生产环境)，内容将瞬间出现在所有已连接的浏览器中。该项目基于 React、Convex 和 Vite 构建，并针对 AEO（人工智能优化）、GEO（生成式引擎优化）和 LLM 发现进行了优化。

发布原理： 以 Markdown 格式编写文章，运行相应的同步命令，它们会立即在你的实时站点上呈现。无需重新构建或重新部署。Convex 处理实时数据同步，因此所有已连接的浏览器都会自动更新。

同步命令：

同步命令脚本位于 scripts/ 目录下 (sync-posts.ts, sync-discovery-files.ts)。

开发环境：

• npm run sync - 同步 Markdown 内容
• npm run sync:discovery - 更新发现文件 (AGENTS.md, llms.txt)
• npm run sync:all - 同时同步内容和发现文件

生产环境：

• npm run sync:prod - 同步 Markdown 内容
• npm run sync:discovery:prod - 更新发现文件
• npm run sync:all:prod - 同时同步内容和发现文件

导出仪表盘内容：

• npm run export:db - 将仪表盘的文章/页面导出到内容文件夹（开发环境）
• npm run export:db:prod - 导出仪表盘文章/页面（生产环境）

版本控制原理： Markdown 文件位于 content/blog/ 和 content/pages/ 目录中。它们是你 Git 仓库中的普通文件。你可以像处理任何代码库一样提交更改、审查差异 (diff) 并回滚版本。同步命令会将内容推送到 Convex。

# 编辑、提交、同步
git add content/blog/my-post.md
git commit -m "Update post"
npm run sync        # 开发环境
npm run sync:prod   # 生产环境

文档

完整文档请访问 markdown.fast/docs

指南

• 设置指南 - 完整的 Fork 和部署指南
• Fork 配置指南 - 自动化或手动 Fork 设置
• 仪表盘指南 - 内容管理与网站配置
• MCP Server - 用于 Cursor 和 Claude Desktop 的 AI 工具集成
• AgentMail 设置 - 通讯和联系表单集成
• WorkOS 设置 - 旧版身份验证模式（在 siteConfig 中使用 auth.mode: "workos"）

AI 开发工具

该项目包含针对 AI 编码助手优化的文档：

• CLAUDE.md - Claude Code CLI 的项目说明，包含工作流、命令和规范
• AGENTS.md - 帮助 AI Agent 理解代码库结构的通用指令
• llms.txt - 位于 /llms.txt 的 AI Agent 发现文件
• .cursor/skills/ - 专项技能文档：
  • frontmatter.md - 完整的 Frontmatter 语法和所有字段选项
  • convex.md - 此应用特有的 Convex 模式
  • sync.md - 同步命令的工作原理与内容流
  • robel-auth/SKILL.md - @robelest/convex-auth 集成模式
  • convex-self-hosting/SKILL.md - Convex 静态自托管设置

这些文件会在 npm run sync:discovery 执行期间自动更新，包含当前站点统计信息。

特性

查看 About 页面 获取完整特性列表。

主要特性包括：实时同步、四种主题选项、全文搜索、分析仪表盘、用于 AI 工具的 MCP Server、通讯订阅集成，以及包含 RSS 订阅、站点地图和结构化数据的 SEO 优化。

Fork 配置

Fork 项目后，运行自动化配置：

cp fork-config.json.example fork-config.json
# 使用你的站点信息编辑 fork-config.json
npm run configure

fork-config.json.example 包含所有可配置选项：

• 站点设置：名称、标题、描述、URL、域名
• 认证模式：convex-auth (默认)、workos (旧版) 或 none (本地开发)
• 托管模式：convex-self-hosted (默认) 或 netlify (旧版)
• 媒体提供商：convex (默认)、convexfs 或 r2
• 创建者信息：姓名、社交链接、个人简介
• 特性开关：通讯订阅、仪表盘、统计页面、AI 聊天等。

详细说明请参考 Fork 配置指南 以及完整参考文件 FORK_CONFIG.md。

一键设置路径