vimdown

vimdown ist ein schmutziges Werkzeug .vimrc und .vim Script-Dateien zu konvertieren Abschlag.
Installieren
Der einfachste Weg, zu installieren, ist pip verwenden
pip installieren vimdown
Oder Sie wählen eine Installations Download GitHub können
Überblick
Vimdown verwandelt .vim Dateien in Markdown-Dokumente.
Vimdown wurde von einem Juckreiz, um meine .vimrc schön aussehen als README.mkd Datei für meine GitHub-Repository, das meine .vim Verzeichnis enthält geboren.
Diese README wurde als vim-Datei geschrieben und gemacht mit vimdown Markdown.
Vimdown ist eine sehr einfache Parser. Denn es macht nicht separat ein Vim-Datei in Textblöcke, die entweder zusammenhängend oder Kommentare zusammenhängenden nicht-Kommentare. Die Blöcke der Kommentare werden von ihren Kommentarzeichen beraubt, '"', von Anfang der Linie und als im Markdown-Syntax. Nichtkommentarblöcke werden als Codeblöcke und werden in die resultierende Abschlag Dokument als explizite vim Codeblöcke eingefügt. Nur Zeilen mit dem Kommentarzeichen '"', wie die erste oder zweite Zeichen der Zeile werden als Kommentar. Wenn die Kommentarzeichen beginnt später in der Zeile wird als Code mit einem Kommentar im Codeblock werden.
Verwendung
Vimdown in Hilfeausgabe gebaut
> Vimdown --help
Basic
Geben Sie einfach den Befehl vimdown eine oder mehrere Dateien zu verarbeiten und es wird aus dem Ergebnis nach stdout schreiben:
> Vimdown infile> outfile
Sie können eine Ausgabedatei angeben:
> Vimdown -o Ausgabedatei infile
Die Verwendung mehrerer Eingabedateien:
> Vimdown infile infile2 infile3 -o Ausgabedatei
Erweitert
Markdown2 Codeblöcke
Sie können markdown2 Stil Codeblöcke mit -c haben:
> Vimdown -c -o Ausgabedatei infile
Das wird Code-Blöcke in der Abschlag im Stil erstellen:
& Nbsp; ::: vim
& Nbsp; Code ist hier
in HTML-Render
Wenn Sie installiert haben, können Sie markdown2 vimdown bitten, den Abschlag zu HTML für Sie mit der Option -t zu machen.
Dies wird eine Grund Abschlag Dokument als HTML in die Ausgabedatei machen
> Vimdown -t -o Ausgabedatei infile
Dies wird ein Abschlag Dokument mit markdown2 Codeblöcke als HTML in die Ausgabedatei machen
> Vimdown -c -t -o Ausgabedatei infile
Pygments Styles
Wenn Sie sowohl Markdown2 und Pygments installiert haben kann vimdown die Ausgabe als HTML-Dokument mit dem Code-Markup für Pygments Stil zu machen. Mit der Option -p:
> Vimdown -p -o Ausgabedatei infile
Beispiele
Zur Praxis immer von vimdown sehen, Kasse der README für die Viming-Mit-Buttars Projekt.
Alles, was Sie in dem Dokument bisher gesehen haben, ist ein Beispiel, wie vimdown macht Anmerkungen im vim-Datei.
Kommentarsätze müssen die '"' Kommentarzeichen in der ersten oder zweiten Zeichenposition der Zeile.
Der Kommentarblock:
"# Kommentar
"_comment_
"Kommentar
machen wird als:
Kommentar
Kommentar
Kommentar
Ein weiterer Kommentarblock, beginnt der Kommentar in einem Extra-Raum:
& Nbsp; "[Kommentar] (http://google.com)
& Nbsp; "Kommentar
& Nbsp; "__comment__
macht als:
Kommentar
Kommentar
Kommentar
Dies wird als ein Code-Block werden:
& Nbsp; "[Kommentar] (http://google.com)
& Nbsp; "# Kommentar
& Nbsp; "Kommentar
wie gemacht:
& Nbsp; "[Kommentar] (http://google.com)
& Nbsp; "# Kommentar
& Nbsp; "Kommentar
Die folgenden Beispiele sind, wie es Codeblöcke rendern.
wenn die Variable <10
& Nbsp; sei g: variable = 0
endif
Ein Codeblock mit Kommentaren
wenn filereadable (Tstr)
& Nbsp; "sicherzustellen, dass unsere big ass bsd-Tags-Datei
& Nbsp; "wird in Unterverzeichnisse zum Einsatz.
& Nbsp; Satz Tags + = Tstr "Kommentar am Zeilenende
endif

Anforderungen :

• Python