Иконка программы Slate API Docs Generator 11 Лайк

Аналоги Slate API Docs Generator

Создавайте красивую, интеллектуальную, отзывчивую документацию для API.
Официальный сайт программы
  • Бесплатная
  • Mac OS

Slate - красивая статическая документация для вашего API.

Характеристики:

1) Чистый, интуитивно понятный дизайн. В Slate описание вашего API находится слева от вашей документации, а все примеры кода - справа. Slate - гибкий, поэтому отлично смотрится на планшетах, телефонах и даже в печати;

2) Все на одной странице. Прошли те времена, когда вашим пользователям приходилось искать по миллиону страниц, чтобы найти то, что они хотели. Slate размещает всю документацию на одной странице. Однако мы не пожертвовали связанностью. При прокрутке хеш вашего браузера будет обновляться до ближайшего заголовка, поэтому ссылки на определенный пункт в документации все еще естественны и просты;

3) Slate - это просто Markdown. Когда вы пишете документы на Slate, вы просто пишете Markdown, что упрощает редактирование и понимание. Все написано в Markdown, даже примеры кода, это просто блоки кода Markdown;

4) Возможность писать примеры кода на нескольких языках. Если у вашего API есть привязки на нескольких языках программирования, вы можете легко вкладывать вкладки для переключения между ними. В своем документе вы будете различать разные языки, указав название языка в верхней части каждого блока кода, как в Github Flavored Markdown;

5) Встроенная подсветка синтаксиса почти для 60 языков, настройка не требуется;

6) Автоматическое, плавно прокручивающееся оглавление в дальнем левом углу страницы. При прокрутке отображается текущая позиция в документе. Это очень быстро. Мы используем Slate в TripIt при создании документации для нашего нового API, где в оглавлении содержится более 180 записей. Мы убедились, что производительность остается отличной даже для больших документов;

Альтернативы для Slate API Docs Generator

Платформа
Персональный компьютер

Windows Mac OS

Мобильный телефон

Android iOS (iPhone / iPad)

Сбросить фильтр
  • Иконка программы Doxygen 44
  • Doxygen - это инструмент для генерации документации.

    • Бесплатная
    • Windows
    • Mac OS
    Скриншот 1 программы Doxygen

    Doxygen - это инструмент для генерации документации из аннотированных источников C ++, а также других популярных языков программирования, таких как C, Objective-C, C #, PHP, Java, Python, IDL (разновидности CORBA, Microsoft и UNO / OpenOffice), Fortran, VHDL, Tcl и в некоторой степени D.

  • Иконка программы swagger.io 17
  • Swagger - это инструмент для документирования RESTapi с открытым исходным кодом.

    • Бесплатная
    • Windows
    • Mac OS
    • Онлайн сервис
    Скриншот 1 программы swagger.io

    Swagger - это инструмент для документирования RESTapi с открытым исходным кодом.