2012-04-02 22 views
10

Pracując na dokumentowanie dość dużą REST API i szuka dobrej prezentacji szczególnie natknąłem dokumentacji stripe.com API: https://stripe.com/docs/apistylowa dokumentacja rocco dla API-like stripe.com-?

Początkowo zaczynaliśmy dokumentowania użycia API w prostym pliku tekstowym, a ja robię postępy na teraz na project.But że będę mieć inne inżynierów pracujących ze mną i użytkownikom interakcji z API chciałbym stworzyć coś podobnego dokumentacji stripe.com.

Natrafiłem na rocco i jest całkiem niezły! ale nie mam pojęcia, jak paski peeps sformatowały kolumnę po prawej stronie, aby renderować pogrubione tytuły, json ładunek i ....

Dowolne przykłady?

Jestem w pełni świadomy, że dokumentacja API jest dość powszechnym pytaniem, ale pytam o to, jak używać rocco do podobnych, aby renderować coś więcej niż kod po prawej stronie kolumny.

Thx!

Odpowiedz

1

Nie jestem pewien, jak to zrobić z rocco, ale w przypadku, gdy możesz zmienić budowniczego masz klejnot api_docs, który zapewnia ładną wyjściową formatowanie bootstrap.

api_doc output example