Slate API Docs Generator

Slate API Docs Generator

Łupek - piękna dokumentacja statyczna dla Twojego API
Łupek - piękna dokumentacja statyczna dla twojego API.Funkcje Czysty, intuicyjny design - w Slate opis interfejsu API znajduje się po lewej stronie dokumentacji, a wszystkie przykłady kodu po prawej stronie.Zainspirowany dokumentami API Stripe i Paypal.Slate reaguje szybko, więc świetnie wygląda na tabletach, telefonach, a nawet w druku.Wszystko na jednej stronie - dawno minęły czasy, gdy użytkownicy musieli przeszukiwać milion stron, aby znaleźć to, czego chcieli.Slate umieszcza całą dokumentację na jednej stronie.Nie poświęciliśmy jednak możliwości łączenia.Podczas przewijania skrót przeglądarki zostanie zaktualizowany do najbliższego nagłówka, więc połączenie z określonym punktem w dokumentacji jest nadal naturalne i łatwe.Slate to po prostu Markdown - Kiedy piszesz dokumenty w Slate, piszesz po prostu Markdown, co ułatwia edycję i zrozumienie.Wszystko jest napisane w Markdown - nawet próbki kodu to tylko bloki kodu Markdown.Napisz przykłady kodu w wielu językach - jeśli interfejs API ma powiązania w wielu językach programowania, możesz łatwo wstawiać karty, aby się między nimi przełączać.W dokumencie rozróżniasz różne języki, podając nazwę języka u góry każdego bloku kodu, podobnie jak w przypadku Github Flavored Markdown.Gotowe podświetlanie składni dla prawie 60 języków, nie wymaga konfiguracji.Automatyczny, płynnie przewijany spis treści po lewej stronie.Podczas przewijania wyświetla bieżącą pozycję w dokumencie.Jest też szybki.Używamy Slate w TripIt do tworzenia dokumentacji dla naszego nowego API, w którym nasz spis treści zawiera ponad 180 pozycji.Zadbaliśmy o to, aby wydajność pozostała doskonała, nawet w przypadku większych dokumentów.
slate-api-docs-generator

Stronie internetowej:

Kategorie

Alternatywy dla Slate API Docs Generator'a dla wszystkich platform z dowolną licencją

Doxygen

Doxygen

Doxygen to narzędzie do generowania dokumentacji ze źródeł C ++ z adnotacjami, a także innych popularnych języków programowania, takich jak C, Objective-C, C #, PHP, Java, Python, IDL (CORBA ...
swagger.io

swagger.io

Swagger to otwarte narzędzie dokumentacji RESTapi.
Daux.io

Daux.io

Daux.io to generator dokumentacji, który wykorzystuje prostą strukturę folderów i pliki Markdown do tworzenia niestandardowej dokumentacji w locie.Pomaga tworzyć świetnie wyglądającą dokumentację w sposób przyjazny dla programistów.
Docsie

Docsie

Docsie to bezpłatne oprogramowanie do współpracy w zakresie dokumentów oprogramowania, intranetów i zarządzania wiedzą.Z łatwością twórz dokumentację oprogramowania w Docsie i osadzaj ją w swojej witrynie lub wewnętrznym portalu za pomocą ciągu JavaScript.
Wikitten

Wikitten

Wikitten to mała, hostowana wiki, kompatybilna ze stronami Markdown i HTML oraz przyjazna dla Git.
Sandcastle

Sandcastle

Sandcastle tworzy dokładną, kompleksową dokumentację w stylu MSDN, odzwierciedlając zespoły źródłowe i opcjonalnie integrując komentarze do dokumentacji XML.
Codex

Codex

Codex to prosta oparta na plikach platforma dokumentacji Markdown zbudowana na Laravel.Jest całkowicie konfigurowalny i bardzo prosty w użyciu, aby stworzyć piękną dokumentację.
ReadMe

ReadMe

ReadMe to w pełni konfigurowalne i oparte na współpracy miejsce dla dynamicznego API i / lub dokumentacji produktu.
NDoc

NDoc

NDoc generuje dokumentację biblioteki klas z zestawów .NET i plików dokumentacji XML generowanych przez kompilator C # (lub za pomocą narzędzia dodatkowego dla VB.NET).
DoxyS

DoxyS

DoxyS to narzędzie do dokumentacji kodu dla C ++ / C.DoxyS dąży do uzyskania bardzo profesjonalnie wyglądających wyników, prezentując kod w uporządkowanym, łatwym w nawigacji zestawie stron HTML.
CppDoc

CppDoc

CppDoc generuje dokumentację HTML dla klas C ++ na podstawie kodu źródłowego i osadzonych w nim specjalnych komentarzy.
Docuie

Docuie

Docuie zapewnia niedrogą dokumentację dla pojedynczych programistów, aż do klientów korporacyjnych.Dokumentacja jest niezwykle łatwa w konfiguracji, wystarczy tylko kilka kliknięć.
Document! X

Document! X

Dokument!X to połączenie zautomatyzowanego narzędzia do dokumentacji i pełnego środowiska tworzenia treści, które można wykorzystać do tworzenia, publikowania i utrzymywania dokładnej dokumentacji o profesjonalnej jakości dla .NET, usług internetowych, baz danych, XSD, Java, Javascript.
Aglio

Aglio

aglio - renderer Blueprint API, który obsługuje wiele motywów i generuje statyczny HTML, który może być obsługiwany przez dowolny host internetowy.
Natural Docs

Natural Docs

Natural Docs to generator dokumentacji typu open source dla wielu języków programowania.Dokumentujesz swój kod w naturalnej składni, która brzmi jak zwykły angielski.