API
Advanced Layout Syntax
高级排版模块的基础写法、容易写错的地方,以及第一次接入时最稳的示例。
Advanced Layout Syntax
这页只讲写法。
常见问题通常不是“不好看”,而是:
- 字段名写错
- 冒号写错
- 行列表缺列
- 模块名写错
- 必填字段漏了,结果整块不渲染
基本写法
所有高级模块都必须用三冒号块:
:::模块名
字段: 内容
:::带标题的行列表模块,可以这样写:
:::metrics[核心数据]
留存率 | 42% | 新结构上线后读者更愿意读完 | accent
:::最容易写错的几条
1. 字段必须用英文冒号
正确:
title: 先把结论讲清楚错误:
title:先把结论讲清楚2. 行列表模块必须用竖线分隔
正确:
产品稿 | 先讲变化 | 不要让重点埋在第三屏之后 | accent错误:
产品稿 - 先讲变化 - 不要让重点埋在第三屏之后3. 必填列不能空着
正确:
教程稿 | 阅读完成率 +31% | 步骤拆开后更容易跟着做 | accent错误:
教程稿 | | 步骤拆开后更容易跟着做4. 模块名要按文档写
比如图文说明模块必须写:
:::image-text不要写成:
:::image_text最小可用示例
如果你第一次接高级排版,先从这段开始:
:::hero
title: 先把这篇值不值得看说清楚
subtitle: 先把重点交代清楚,读者读起来会轻松很多
tags: 模块 | 公众号 | 结构
:::
:::cards[这篇会解决什么]
判断 | 第一屏先给结论 | 读者不用滑很久才知道重点 | accent
阅读 | 手机里更不累 | 信息分层比花样更多更重要 | default
行动 | 结尾更明确 | 收藏、关注、咨询都有落点 | default
:::Agent 最该遵守的写法原则
如果你是让 Agent 生成这类 Markdown,先守住这几个原则:
- 先判断内容任务,再选模块
- 一篇文章优先用 3 到 6 个模块,不要堆满
- 同一屏只讲一个主判断
- 模块先服务信息层次,再服务视觉变化
常见失败怎么排
整块没显示
优先检查:
- 模块名是不是写错了
- 必填字段是不是缺了
- 字段冒号是不是中文
有框架,没内容
优先检查:
- 行列表是不是少列
- 图片地址是不是空的
- 标题或正文是不是都没填
看起来很乱
优先检查:
- 一篇里是不是用了太多模块
- 开场是不是同时塞了判断、数据、案例、行动
- 该用普通正文的地方,是不是也硬塞进模块了
下一步
写法弄清楚以后,下一步就是选模块。
继续看: