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 за всички платформи с всякакъв лиценз

Doxygen

Doxygen

Doxygen е инструмент за генериране на документация от коментирани източници на C ++, както и други популярни езици за програмиране като C, Objective-C, C #, PHP, Java, Python, IDL (CORBA ...
swagger.io

swagger.io

Swagger е инструмент за документация с отворен код RESTapi.
Daux.io

Daux.io

Daux.io е генератор на документация, който използва проста структура на папки и файлове Markdown, за да създава персонализирана документация в движение.Помага ви да създадете страхотна документация по приятелски начин за програмисти.
Docsie

Docsie

Docsie е безплатен софтуер за сътрудничество за софтуерни документи, интранети и управление на знанието.Лесно създайте вашата софтуерна документация в Docsie и я вградете във вашия сайт или вътрешен портал с низ от JavaScript ..
  • Безплатно
  • Web
Wikitten

Wikitten

Wikitten е малка самостоятелно хоствана уики, която е съвместима с Markdown и HTML страници и Git-friendly.
Sandcastle

Sandcastle

Sandcastle произвежда точна, MSDN стил, изчерпателна документация, като разсъждава над сборките на източника и по желание интегрирайки XML Documentation Comments.
Codex

Codex

Codex е обикновена файлова платформа за документация на Markdown, изградена върху Laravel.Той е напълно приспособим и мъртъв, лесен за използване за създаване на красива документация.
ReadMe

ReadMe

ReadMe е напълно приспособимо и съвместно място за динамичен API и / или документация на продукта.
  • Платено
  • Web
NDoc

NDoc

NDoc генерира документация за библиотека на класове от .NET асембли и файлове с XML документация, генерирани от компилатора C # (или с добавъчен инструмент за VB.NET).
DoxyS

DoxyS

DoxyS е инструмент за документация на код за C ++ / C.DoxyS се стреми да постигне много професионално изглеждащ резултат, представяйки кода в структуриран лесен за навигиране набор от HTML страници.
CppDoc

CppDoc

CppDoc генерира HTML документация за класове C ++ въз основа на вашия изходен код и специални коментари, вградени в него.
Docuie

Docuie

Docuie предоставя достъпна документация за отделни разработчици до корпоративните клиенти.Документацията е изключително лесна за настройване само с няколко клика.
Document! X

Document! X

Документ!X е комбинация от автоматизиран инструмент за документация и пълна авторска среда, която може да се използва за създаване, публикуване и поддържане на точна, професионална документация за качество за .NET, уеб услуги, бази данни, XSD, Java, Javascript.
Aglio

Aglio

aglio - API Blueprint API, който поддържа множество теми и извежда статичен HTML, който може да се обслужва от всеки уеб хост.
Natural Docs

Natural Docs

Natural Docs е генератор на документация с отворен код за множество езици за програмиране.Вие документирате кода си в естествен синтаксис, който се чете като обикновен английски.