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

Особенности

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

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

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

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

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

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