Slate API Docs Generator

Описание

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

Особенности сервиса

• Чистый, интуитивно понятный дизайн.
• В Slate описание вашего API находится слева от вашей документации, а все примеры кода — справа.
• Slate — гибкий, поэтому отлично смотрится на планшетах, телефонах и даже в печати.
• Все на одной странице. Прошли те времена, когда вашим пользователям приходилось искать по миллиону страниц, чтобы найти то, что они хотели. Slate размещает всю документацию на одной странице.
• Slate — это просто Markdown. Когда вы пишете документы на Slate, вы просто пишете Markdown, что упрощает редактирование и понимание. Все написано в Markdown, даже примеры кода, это просто блоки кода Markdown.
• Возможность писать примеры кода на нескольких языках. Если у вашего API есть привязки на нескольких языках программирования, вы можете легко вкладывать вкладки для переключения между ними. В своем документе вы будете различать разные языки, указав название языка в верхней части каждого блока кода, как в Github Flavored Markdown.
• Встроенная подсветка синтаксиса почти для 60 языков, настройка не требуется.
• Автоматическое, плавно прокручивающееся оглавление в дальнем левом углу страницы. При прокрутке отображается текущая позиция в документе. Это очень быстро. Мы используем Slate в TripIt при создании документации для нашего нового API, где в оглавлении содержится более 180 записей.