redtape

redtape ist ein spezialisierter Dokument-Generator, der Github aromatisierte Abschlag verwendet, um eine einfache, attraktive HTML-Dokumente zu generieren. Es integriert sich automatisch in Twitter Bootstrap und ist einfach und attraktiv Styling. redtape durch d inspiriert, sondern versucht, eine einfache Schnittstelle haben und es trotzdem erlauben, um Stil und ihre Ausgabe von Dokumenten auf einen hohen Individualisierungsgrad zu steuern.
Installation
Wenn Sie unter Linux oder OSX sind, können Sie pip verwenden können, um zu installieren:
> Pip redtape installieren
Was wird redtape und ihre Abhängigkeiten zu installieren.
Verwendung
Um auf ein Dokument oder ein Verzeichnis voller Dokumente verwenden, laufen rt. Wenn in einem Verzeichnis ausführen, wird rt HTML-Dateien für jeden Abschlag Datei (.md, .mdown oder .markdown Erweiterungen) zu erstellen:
> Rt mydocument.md
> Rt Dokumentation /
Vermögen
Standardmäßig nimmt rt Sie einen Speicherort für die Dateien, aus denen das Vermögen haben, die Links in diesen Unterlagen dienen rt gesetzt haben. Das Layout ist genau das gleiche wie der Aktivverzeichnis im redtape Repository: / assets / {css, img, js} / .. für jeden Vermögenswert, die Sie verwenden werden. Wenn Sie die Standardanlagen redtape verwenden möchten, können Sie einfach einen passenden Asset-Verzeichnis im aktuellen Verzeichnis, indem Sie:
> Rt --create-Vermögenswerte
Wenn Sie im Dokument-Modus ausgeführt wird oder nicht wollen, auf der eventuelle Host für Ihre HTML-Dokumente die Einrichtung eines Vermögensverzeichnisses können Sie redtape sagen, jeden Vermögenswert in einem Dokument mit Hilfe --embed verwendet einbetten:
> Rt --embed mydocument.md
Javascript
Standardmäßig redtape kein Javascript erforderlich laufen, und wird nicht in --embed Modus einbetten jeder. Wenn die --prettify Option ausgewählt ist, wird Googles verschönern Bibliothek für Quellhervorhebung statt pygments verwendet werden, und wenn --prettify und --embed beide verwendet werden, wird es automatisch eingebettet werden.
Redtape ist auch für einfache Einzelseiten Javascript-Demonstrationen, und wenn --use-js aktiviert ist, wird redtape gehören jQuery und JavaScript-Bibliotheken Bootstrap ist.
Anpassen Ausgang
Anpassen Ausgang ist einfach in einer Vielzahl von Möglichkeiten. Außer dem Ändern des Vermögens CSS für nicht eingebettete Dokumente, können Sie auch Kopf- und Fußzeilen hinzuzufügen oder sogar benutzerdefinierte Dokumentvorlagen basierend auf redtape die Standardvorlage.
Kopf- und Fußzeilen
Wenn Sie eine benutzerdefinierte Dokumenten Header oder Fußzeile Sie Ihre Dokumente hinzugefügt werden soll, können Sie entweder header.html und footer.html Dokumente zum Basisverzeichnis Sie machen werden oder setzen Standardpfade in der Config wie Kopf- und Fußzeilen verwendet werden. Standardmäßig werden diese am oberen und unteren Rand des Dokuments platziert werden, auf.
Eine Probe Satz Dokumente können sein:
> Ls mydocs /
mydocs / index.md mydocs / simple.md mydocs / advanced.md
mydocs / header.html mydocs / footer.html
Rendering mydocs mit rt mydocs wird die Kopf- und Fußzeile für jedes Dokument in dem Verzeichnis zu verwenden.
eigene Vorlagen
Sie haben spezifische Anforderungen haben, können Sie Ihre eigenen Dokumentvorlage zu schreiben und haben die volle Kontrolle des Ausgangs. Redtape verwendet die jinja2 Template-Engine, die eine weit verbreitete Template-System ähnlich wie Vorlagen django ist. Führen redtape mit dem --context Argument, eine kurze Vorstellung davon, was Variablen sind auf die Vorlage zur Verfügung.
Sie können auch aus basic.jinja, die den Namen des redtape Standardvorlage erben. Diese Vorlage definiert zwei Blöcke, Kopf und Körper, die Ihnen erlauben, Handwerk eine eindeutige Dokument Körper, während beispielsweise Beibehaltung des Grund CSS- und JavaScript-Funktionalität der redtape. Überschreiben beide werden Sie mit einem Standard HTML5-Dokumentstruktur zu verlassen.
Sie können eine benutzerdefinierte Vorlage angeben, mit -t verwenden, --template oder legen Sie sie in das Dokument Verzeichnis wie custom.html oder custom.jinja

Anforderungen .

• Python