文档不只有段落。警告 callout 用来说明限制,tabs 呈现不同选择,card 引导读者打开下一篇指南。这些组件也是网站表达信息的一部分。
通用富文本编辑器可以处理基础内容。文档工作区还需要理解文字周围支持的组件语法。
从 Collection profile 开始
Prosefly 提供通用 Markdown 和 MDX 可视化编辑,也针对已识别的 Starlight、Fumadocs 和 @prosefly/astro-components 语法提供专门支持。当前 Collection profile 决定编辑器可以处理哪些支持的内容块。
这种支持不代表 Prosefly 会执行仓库代码,也不代表它可以渲染任意 MDX 组件。一个组件可以在网站中正常使用,但仍然需要在 Source 中编辑。
使用熟悉的文档内容块
支持的 profile 让作者能够编辑已识别的 callout、tabs 和 cards 等内容块。具体范围取决于 profile 和组件语法。作者可以专注于说明,同时保留网站所使用的文档格式。
完整源码始终需要可用。当一个内容块使用不支持的语法、自定义表达式,或 profile 无法安全理解的配置时,可以在 Source 中编辑整个文件。
作为内容审查最终结果
编辑器只是工作流的一部分。发布前,应审查 Markdown 或 MDX 变更,以及支持的页面属性或导航变更。最终如何渲染,仍然由网站现有的构建流程负责。