16
Slate API Docs Generator
Łupek - piękna dokumentacja statyczna dla Twojego API
- Darmowa
- Self-Hosted
- Mac
- Linux
Ł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:
https://github.com/tripit/slateKategorie
Alternatywy dla Slate API Docs Generator dla Self-Hosted
12
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.
- Darmowa
- Self-Hosted
8
Wikitten
Wikitten to mała, hostowana wiki, kompatybilna ze stronami Markdown i HTML oraz przyjazna dla Git.
- Darmowa
- Self-Hosted
4
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ę.
- Darmowa
- Self-Hosted
1
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.
- Darmowa
- Self-Hosted