在API蓝图中添加纯文本标题

Question

API Blueprint似乎有一个未记录的规则，可以阻止资源组下方或之间的纯文本标题。我的资源组上方有三个纯文本标题，显示没有问题，但如果我尝试在其下面放置一个纯文本标题，我会在Apiary中得到以下“语义问题”：

<div class="info">
  <h3>Info</h3>
  <img src="http://via.placeholder.com/70x113" alt="Image">
  <p>Dolor blanditiis cum obcaecati quibusdam mollitia modi. Accusamus error culpa quaerat aliquam doloremque Deserunt sit vel corrupti repellat quod animli est impedit? Adipisci sit magni recusandae quod quaerat.<p>
</div>

documentation状态“在定义另一个组之前，任何后续资源定义都被视为该组的一部分”，但它不涉及其他类型的标头。

是否可以克服这个问题，还是需要将所有纯文本标题保留在资源组之上？

Answer 1

  

我是否需要将所有纯文本标题保留在资源组上方？

是即可。即使在那里它可能/应该失败。

在API蓝图中打开资源组部分后，只能执行以下操作：

• 0+ 资源组部分
  • 0+ 资源部分
• 0+ 数据结构部分

API Blueprint中Markdown注释的设计空间是在记录的部分标题（资源，组，...）下的缩进块。这在文档中称为section description。

API Blueprint文档的完整结构符合this语法。