概览
为文档和结构化资源选择合适的编辑器。
Prosefly 提供两种编辑器:可视化编辑器用于 Markdown 和 MDX 文档,资源编辑器用于 JSON 和 YAML 数据文件。两者都将草稿保存在内容空间中,发布则是独立的操作。
免登录体验编辑器
连接仓库前,可以先打开 Markdown 示例 编辑一篇示例文档。选择 Starlight、Fumadocs 或 Prosefly 示例,体验受支持的 MDX 组件、页面属性和导航,再对比自己的改动。
修改仅保留在当前标签页,刷新后会重置。示例不会连接 GitHub、保存共享草稿或发布内容。
选择编辑器
| 内容类型 | 编辑器 | 使用指南 |
|---|---|---|
| Markdown 和 MDX 文档 | 可视化编辑器,也可切换到源码模式 | 可视化编辑器 |
| JSON 和 YAML 资源 | 资源编辑器,提供可视化与代码模式 | 资源编辑器 |
Collection 的文件类型和配置决定打开哪种编辑器。资源文件通过字段和列表编辑,没有文档正文。
Markdown 与组件支持
各编辑器配置都支持基本的 Markdown 内容。可以先阅读基础语法,再查看表格、任务列表、代码、图表、数学公式、图片、媒体和脚注的专门文档。Mermaid和数学公式文档展示了需要配置支持的渲染,脚注文档介绍如何保留正文引用。
编辑 MDX 时,请选择与文档中组件相匹配的 Collection 配置:Starlight、Fumadocs 或 Prosefly。MDX 组件分组介绍各组件的操作方式、源码语法和配置差异。例如,提示块在这三种配置中都可使用,折叠面板覆盖 Fumadocs、Prosefly 分组和 Starlight Details,链接按钮则是 Starlight 的组件。
编辑器不会执行仓库代码,也不会复现整个网站。自定义组件和不支持的表达式仍可在源码模式中编辑。需要确认最终呈现效果时,请使用网站原有的构建和预览流程。
草稿与发布
文档的可视化编辑会自动保存,离开前请确认保存状态。资源文件修改后需要点击保存草稿。保存草稿不会修改 Git 仓库。
发布前,通过发布审阅检查实际文件差异。内容空间的发布设置决定变更以 Commit 还是 Pull Request 的形式写入仓库。
写作辅助
最后更新于 2026年10月19日