Как добавить изображения/диаграммы в API Blueprint?

Question

Мы хотели бы интегрировать изображения в нашу документацию API на Apiary, как способ документирования базовой архитектуры приложения или для иллюстрации типовых рабочих процессов/диаграмм последовательности. Однако поиск по Apiary documentation и API Blueprint Specification, похоже, не дает никаких результатов о том, как это можно сделать.

Можно ли добавлять изображения в API Blueprint? Или эти изображения должны размещаться снаружи и ссылаться по URL-адресу?

Answer 1

David - API Blueprint основан на синтаксисе Markdown (как и во многих других местах, включая комментарии GitHub). Вы можете использовать следующий синтаксис для вставки изображения в Markdown (и API Blueprint):

![name](/url)

Эти изображения действительно должны быть размещены снаружи и ссылки через URL.