Slate API Docs Generator

Slate API Docs Generator

Slate - красива статична документация за вашия API.Features
Slate - красива статична документация за вашия API.Характеристики Чист, интуитивен дизайн - С Slate описанието на вашия API е отляво на документацията ви, а всички примери за кодове са от дясната страна.Вдъхновен от документите за API на Stripe и Paypal.Slate е отзивчив, така че изглежда страхотно на таблети, телефони и дори при печат.Всичко на една страница - Отминаха дните, в които вашите потребители трябваше да търсят през милион страници, за да намерят това, което искат.Slate поставя цялата документация на една страница.Не сме жертвали обаче свързаността.Докато превъртате, хешът на браузъра ви ще се актуализира до най-близкия заглав, така че свързването към конкретна точка от документацията все още е естествено и лесно.Slate е просто Markdown - Когато пишете документи с Slate, вие просто пишете Markdown, което го прави лесен за редактиране и разбиране.Всичко е написано на Markdown - дори кодовите проби са само кодови блокове на Markdown.Напишете кодови проби на няколко езика - Ако вашият API има връзки на няколко езика за програмиране, можете лесно да поставите раздели, за да превключвате между тях.Във вашия документ ще различавате различни езици, като посочвате името на езика в горната част на всеки кодов блок, точно както при Github Flavored Markdown.Подчертаване на синтаксиса извън кутията за почти 60 езика, не се изисква конфигурация.Автоматично, плавно превъртане на съдържанието в крайната лява част на страницата.Докато превъртате, той показва текущата ви позиция в документа.Бързо също.Използваме Slate в TripIt, за да създадем документация за новия ни API, където съдържанието ни има над 180 записа.Ние се уверихме, че представянето остава отлично, дори за по-големи документи.
slate-api-docs-generator

Категории

Алтернативи на Slate API Docs Generator за BSD с търговски лиценз