2012-04-02 8 views
10

Während der Arbeit vor allem einen ziemlich großen REST api und die Suche nach guter Präsentation auf der Dokumentation, stieß ich auf der stripe.com api Dokumentation: https://stripe.com/docs/apistilvolle rocco Dokumentation für API-like stripe.com-?

ich mit Dokumentation der API-Nutzung in einer einfachen Textdatei zunächst gestartet, während ich Fortschritte mache auf das Projekt.Aber jetzt, dass ich andere Ingenieure mit mir arbeiten und Benutzer mit der API interagieren möchte ich etwas wie die Stripe.com-Dokumentation zu produzieren.

Ich stieß auf Rocco, und es ist ziemlich nett! aber ich habe keine Ahnung, wie Stripe Peeps die rechte Spalte formatiert, um fett gedruckte Titel, Json Payload und ....

Beliebige Beispiele?

Ich bin ziemlich bewusst, dass die API-Dokumentation eine ziemlich häufige Fragen ist, aber ich frage, wie man Rocco zu verwenden, um mehr als nur Code auf der rechten Spalte zu rendern.

Thx!

Antwort

1

Nicht sicher, wie man es mit rocco macht, aber wenn Sie den Erbauer ändern können, haben Sie api_docs Edelstein, der eine nette bootstrap formatierte Ausgabe liefert.

api_doc output example