So etwas wie diese ? Funktioniert eindeutig offline. Zitieren ...
Verwenden des Wiki-Markups ohne Wiki
Auch wenn Wiki das Hauptdokumentations-Repository ist, endet nicht die gesamte Dokumentation in einem Wiki. Einige Dokumentationen müssen als Teil des Quellbaums verwaltet werden, z. B. Readme-Anweisungen, Kompilierungsanweisungen und ähnliches. Diese Informationen sind normalerweise entweder Nur-Text oder in irgendeiner Form eines Textverarbeitungsformats, meistens Microsoft Word-kompatibel. Beide haben eine Auswahl von Problemen. Word-Dokumente sind umfangreich, aufgebläht, schwieriger versionierbar und in Shell-Umgebungen nicht lesbar (versuchen Sie, ein Word-Dokument zu kitten oder zu fassen :-D). Dem Klartextformat fehlt die visuelle Struktur und ohne Überschriften, Fett- / Kursivschrift, Schriftgrößen usw. ist das Lesen schwieriger.
Einige Projekte, an denen ich arbeitete, versuchten, HTML als Dokumentationsformat zu verwenden - aber es war zu schwierig, mit "Programmier-Editoren" zu bearbeiten ... und von MS-Word generiertes HTML ist aus Sicht der Lesbarkeit und der Versionsverwaltung nicht viel besser als das binäre Format.
Ein Format, das erstaunlich gut funktioniert, ist ein Klartext mit Wiki-Markup-Struktur. Es gibt eine große Auswahl verschiedener Markups. Am besten gefällt mir das Textile Markup (welches von vielen Wiki-Systemen einschließlich Confluence implementiert wird ). Textilien sind sehr leicht zu merken, natürlich lesbar und geben dem Dokument ausreichend Struktur, ohne im Weg zu sein. Wenn Sie Textile als „Quellmarkup“ verwenden, können wir den Dokumentinhalt direkt in das Wiki kopieren und einfügen, falls dies erforderlich ist. Textilien können auch sehr einfach in vollwertiges HTML umgewandelt werden, indem Bibliotheken verwendet werden, die für alle interessierenden Sprachen verfügbar sind (in meinem Fall - C #, Java, Python, Ruby - und hoffentlich auch etwas für Objective-C finden), um es in HTML zu konvertieren.
Die beste Funktion bei der Verwendung von Textile ist, dass einige Editoren - nämlich TextMate auf Mac - Textile nativ unterstützen und Überschriften und Schriftattribute auch ohne Vorverarbeitungsschritt richtig anzeigen. Und mit der Preview-Funktion erzeugen Sie sogar gleich HTML. Ähnliches kann mit diesem Plugin sowohl in JEdit als auch in Notepad ++ mit dieser Syntaxdatei durchgeführt werden .