如何将 images/diagrams 添加到 API 蓝图?
How can I add images/diagrams to API Blueprint?
我们希望将图像集成到我们关于 Apiary 的 API 文档中,作为记录底层应用程序架构或说明示例 workflows/sequence 图表的一种方式。但是,通过 Apiary documentation and the API Blueprint Specification 进行搜索似乎没有得到有关如何完成此操作的任何结果。
是否可以将图像添加到 API 蓝图?还是这些图像必须在外部托管并由 URL 引用?
David - API 蓝图基于 Markdown 语法(许多其他地方也是如此,包括 GitHub 评论)。您可以使用以下语法将图像插入 Markdown(和 API 蓝图):
![name](/url)
这些图像确实需要在外部托管并通过 URL 引用。
如另一个答案所述:
![alternative text](/url)
或在 linux 上获取本地图像:
![alternative text](./image.png)
但如果要指定图片大小,直接使用html
<img src="image.png" alt="image alternative text" width="500"/>
我们希望将图像集成到我们关于 Apiary 的 API 文档中,作为记录底层应用程序架构或说明示例 workflows/sequence 图表的一种方式。但是,通过 Apiary documentation and the API Blueprint Specification 进行搜索似乎没有得到有关如何完成此操作的任何结果。
是否可以将图像添加到 API 蓝图?还是这些图像必须在外部托管并由 URL 引用?
David - API 蓝图基于 Markdown 语法(许多其他地方也是如此,包括 GitHub 评论)。您可以使用以下语法将图像插入 Markdown(和 API 蓝图):
![name](/url)
这些图像确实需要在外部托管并通过 URL 引用。
如另一个答案所述:
![alternative text](/url)
或在 linux 上获取本地图像:
![alternative text](./image.png)
但如果要指定图片大小,直接使用html
<img src="image.png" alt="image alternative text" width="500"/>