LINUX.ORG.RU

Как генерировать документацию к Rest-сервису в Markdown?

 , ,


1

1

Есть проект на GitHub/GitLab.

Я умею с помощью (grunt-)jsdox генерировать документацию к модулям из jsdoc тегов в формате Markdown.

Я умею с помощью grunt-mocha-test генерировать документацию как спецификацию тестов в формате Markdown (опция reporter: 'markdown').

Но я еще должен вручную писать markdown документацию для человека - пользователя сервиса.

Есть ли готовые решения для автоматизации этого процесса? Нагуглил Api Blueprint, но непонятно,как его нужно использовать.

Ответ на: комментарий от BigAlex

вопрос был неправильным. Неправильно генерировать для пользователя описание API сервиса в Markdown. Нужен HTML. Который сервис должен отдавать как справку. Для этого и нужен API Blueprint. Для генерации документации по описанию в Node есть grunt-aglio.

EnterpriseMobility
() автор топика
Вы не можете добавлять комментарии в эту тему. Тема перемещена в архив.