CODEWITHSUNDEEP
imageapiblueprintapiary.ioapiary
David
David

Reputation: 2029

How can I add images/diagrams to API Blueprint?

We would like to integrate images into our API documentation on Apiary, as a way of documenting the underlying application architecture or to illustrate sample workflows/sequence diagrams. However, a search through Apiary documentation and the API Blueprint Specification don't seem to yield any results on how this can be done.

Is it possible to add images to API Blueprint? Or do these images have to be hosted externally and referenced by URL?

Upvotes: 6

Views: 2708

Answers (2)

Mark Teese
Mark Teese

Reputation: 691

As described in another answer:

![alternative text](/url)

Or on linux for a local image:

![alternative text](./image.png)

but if you want to specify the image size, use html directly

<img src="image.png" alt="image alternative text" width="500"/>

Upvotes: 2

zzen
zzen

Reputation: 1269

David - API Blueprint is based on Markdown syntax (as are many other places including GitHub comments). You can use the following syntax to insert an image into Markdown (and API Blueprint):

![name](/url)

These images indeed need to be hosted externally and referenced via URL.

Upvotes: 14

Related Questions