Slate API Docs Generator описание, скриншоты и видео

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

Функции

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

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

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

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

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

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