Django-Online-Docs Eine wiederverwendbare Django-App, die Dokumentation für die aktuell angezeigte Ansicht anzeigt
Jetzt downloaden

Django-Online-Docs Ranking & Zusammenfassung

Django-Online-Docs Stichworte

Nutzer Django Dokumentation Benutzerdokumentation.

Django-Online-Docs Beschreibung

Django-Online-Docs ist eine Django-App, um Benutzerdokumentation auf jeder Seite Ihres Projekts anzuzeigen. Die meisten großen Kunden bitten eine Benutzerdokumentation in Microsoft Word-Format. Wir dachten, dass dies verrückt ist, weil wir Webanwendungen auf agiler Weise entwickeln, was bedeutet, dass eine solche Dokumentation fast sofort veraltet wäre. Es würde auch das Problem geben, um die neueste Dokumentation an alle Benutzer zu senden, damit wir dachten, warum nicht nur die Dokumentation auf der Seite selbst einzuschließen. Warum nicht die Dokumentation intelligent genug machen, um nur die Dokumente über die aktuell angezeigte Seite anzuzeigen. Diese App löst die aktuelle URL auf und versucht, eine Markdown-Datei für die aktuell angezeigte Ansicht in einem JQuery-Modal zu laden. Die Dateien müssen einfach in der Apps / static / online_docs / -ordnern gespeichert werden.Now Alles, was Sie tun müssen, ist ausführen ./Manage.py CollectStatic und diese App sollte in der Lage sein, Ihre Dokumentationsdateien zu finden. Bitte beachten Sie, dass dies ein ist Erster Prototyp und ein Begriff des Konzepts für diese Idee. Es ist sehr einfach und verstößt wahrscheinlich trocken und unterstützt I18N nicht. Dies ist auf der Roadmap, allerdings com / bitmazk / django-online-docs.git # Egg = Online_DOCSADD Online_DOCS zu Ihren installierten_Apps: installiert_Apps = (..., 'online_docs',) Hinzufügen von jQuery und jQuery-ui und online_docs.js zu Ihrem base.html. Darüber hinaus geben Ihnen Online_DOCS / CSS / Styles.css einige einfache Stile für die Ausgabe, die Markdown generiert. Sie können dieses Stylesheet auslassen und einfach die Styles in Ihr eigenes Haupt-Stylesheet hinzufügen -UI-1.8.16.custom.css "> ... ...

Django-Online-Docs Zugehörige Software